Files
@ 890f6ae420c2
Branch filter:
Location: CSY/reowolf/reowolf.h
890f6ae420c2
21.6 KiB
text/x-chdr
added example cases to mirror the presentation examples 1-5
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 | /* CBindgen generated */
#ifndef REOWOLF_HEADER_DEFINED
#define REOWOLF_HEADER_DEFINED
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
typedef enum {
EndpointPolarity_Active,
EndpointPolarity_Passive,
} EndpointPolarity;
typedef enum {
Polarity_Putter,
Polarity_Getter,
} Polarity;
typedef struct Arc_ProtocolDescription Arc_ProtocolDescription;
typedef struct Connector Connector;
typedef int32_t ErrorCode;
typedef uint32_t ConnectorId;
typedef uint32_t PortSuffix;
typedef struct {
ConnectorId connector_id;
PortSuffix u32_suffix;
} PortId;
/**
* Given
* - an initialized connector in setup or connecting state,
* - a string slice for the component's identifier in the connector's configured protocol description,
* - a set of ports (represented as a slice; duplicates are ignored) in the native component's interface,
* the connector creates a new (internal) protocol component C, such that the set of native ports are moved to C.
* Usable in {setup, communication} states.
*/
ErrorCode connector_add_component(Connector *connector,
const uint8_t *ident_ptr,
uintptr_t ident_len,
const PortId *ports_ptr,
uintptr_t ports_len);
/**
* Given
* - an initialized connector in setup or connecting state,
* - a utf-8 encoded socket address,
* - the logical polarity of P,
* - the "physical" polarity in {Active, Passive} of the endpoint through which P's peer will be discovered,
* returns P, a port newly added to the native interface.
*/
ErrorCode connector_add_net_port(Connector *connector,
PortId *port,
const uint8_t *addr_str_ptr,
uintptr_t addr_str_len,
Polarity port_polarity,
EndpointPolarity endpoint_polarity);
/**
* Given an initialized connector in setup or connecting state,
* - Creates a new directed port pair with logical channel putter->getter,
* - adds the ports to the native component's interface,
* - and returns them using the given out pointers.
* Usable in {setup, communication} states.
*/
void connector_add_port_pair(Connector *connector, PortId *out_putter, PortId *out_getter);
/**
* Connects this connector to the distributed system of connectors reachable through endpoints,
* Usable in setup state, and changes the state to communication.
*/
ErrorCode connector_connect(Connector *connector, int64_t timeout_millis);
/**
* Destroys the given a pointer to the connector on the heap, freeing its resources.
* Usable in {setup, communication} states.
*/
void connector_destroy(Connector *connector);
ErrorCode connector_get(Connector *connector, PortId port);
const uint8_t *connector_gotten_bytes(Connector *connector, PortId port, uintptr_t *out_len);
/**
* Initializes `out` with a new connector using the given protocol description as its configuration.
* The connector uses the given (internal) connector ID.
*/
Connector *connector_new(const Arc_ProtocolDescription *pd);
Connector *connector_new_logging(const Arc_ProtocolDescription *pd,
const uint8_t *path_ptr,
uintptr_t path_len);
intptr_t connector_next_batch(Connector *connector);
void connector_print_debug(Connector *connector);
/**
* Convenience function combining the functionalities of
* "payload_new" with "connector_put_payload".
*/
ErrorCode connector_put_bytes(Connector *connector,
PortId port,
const uint8_t *bytes_ptr,
uintptr_t bytes_len);
intptr_t connector_sync(Connector *connector, int64_t timeout_millis);
/**
* Given an initialized protocol description, initializes `out` with a clone which can be independently created or destroyed.
*/
Arc_ProtocolDescription *protocol_description_clone(const Arc_ProtocolDescription *pd);
/**
* Destroys the given initialized protocol description and frees its resources.
*/
void protocol_description_destroy(Arc_ProtocolDescription *pd);
/**
* Parses the utf8-encoded string slice to initialize a new protocol description object.
* - On success, initializes `out` and returns 0
* - On failure, stores an error string (see `reowolf_error_peek`) and returns -1
*/
Arc_ProtocolDescription *protocol_description_parse(const uint8_t *pdl, uintptr_t pdl_len);
/**
* Returns length (via out pointer) and pointer (via return value) of the last Reowolf error.
* - pointer is NULL iff there was no last error
* - data at pointer is null-delimited
* - len does NOT include the length of the null-delimiter
* If len is NULL, it will not written to.
*/
const uint8_t *reowolf_error_peek(uintptr_t *len);
#endif /* REOWOLF_HEADER_DEFINED */
/* CBindgen generated */
#ifndef REOWOLF_HEADER_DEFINED
#define REOWOLF_HEADER_DEFINED
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
typedef enum {
EndpointPolarity_Active,
EndpointPolarity_Passive,
} EndpointPolarity;
typedef enum {
Polarity_Putter,
Polarity_Getter,
} Polarity;
typedef struct Arc_ProtocolDescription Arc_ProtocolDescription;
typedef struct Connector Connector;
typedef int ErrorCode;
typedef uint32_t ConnectorId;
typedef uint32_t PortSuffix;
typedef struct {
ConnectorId connector_id;
PortSuffix u32_suffix;
} Id;
typedef Id PortId;
/**
* Given
* - an initialized connector in setup or connecting state,
* - a string slice for the component's identifier in the connector's configured protocol description,
* - a set of ports (represented as a slice; duplicates are ignored) in the native component's interface,
* the connector creates a new (internal) protocol component C, such that the set of native ports are moved to C.
* Usable in {setup, communication} states.
*/
ErrorCode connector_add_component(Connector *connector,
const uint8_t *ident_ptr,
uintptr_t ident_len,
const PortId *ports_ptr,
uintptr_t ports_len);
/**
* Given
* - an initialized connector in setup or connecting state,
* - a utf-8 encoded socket address,
* - the logical polarity of P,
* - the "physical" polarity in {Active, Passive} of the endpoint through which P's peer will be discovered,
* returns P, a port newly added to the native interface.
*/
ErrorCode connector_add_net_port(Connector *connector,
PortId *port,
const uint8_t *addr_str_ptr,
uintptr_t addr_str_len,
Polarity port_polarity,
EndpointPolarity endpoint_polarity);
/**
* Given an initialized connector in setup or connecting state,
* - Creates a new directed port pair with logical channel putter->getter,
* - adds the ports to the native component's interface,
* - and returns them using the given out pointers.
* Usable in {setup, communication} states.
*/
void connector_add_port_pair(Connector *connector, PortId *out_putter, PortId *out_getter);
/**
* Given
* - an initialized connector in setup or connecting state,
* - a utf-8 encoded BIND socket addresses (i.e., "local"),
* - a utf-8 encoded CONNECT socket addresses (i.e., "peer"),
* returns [P, G] via out pointers [putter, getter],
* - where P is a Putter port that sends messages into the socket
* - where G is a Getter port that recvs messages from the socket
*/
ErrorCode connector_add_udp_port(Connector *connector,
PortId *putter[2],
const uint8_t *local_addr_str_ptr,
uintptr_t local_addr_str_len,
const uint8_t *peer_addr_str_ptr,
uintptr_t peer_addr_str_len);
/**
* Connects this connector to the distributed system of connectors reachable through endpoints,
* Usable in setup state, and changes the state to communication.
*/
ErrorCode connector_connect(Connector *connector, int64_t timeout_millis);
/**
* Destroys the given a pointer to the connector on the heap, freeing its resources.
* Usable in {setup, communication} states.
*/
void connector_destroy(Connector *connector);
ErrorCode connector_get(Connector *connector, PortId port);
const uint8_t *connector_gotten_bytes(Connector *connector, PortId port, uintptr_t *out_len);
/**
* Initializes `out` with a new connector using the given protocol description as its configuration.
* The connector uses the given (internal) connector ID.
*/
Connector *connector_new(const Arc_ProtocolDescription *pd);
Connector *connector_new_logging(const Arc_ProtocolDescription *pd,
const uint8_t *path_ptr,
uintptr_t path_len);
intptr_t connector_next_batch(Connector *connector);
void connector_print_debug(Connector *connector);
/**
* Convenience function combining the functionalities of
* "payload_new" with "connector_put_payload".
*/
ErrorCode connector_put_bytes(Connector *connector,
PortId port,
const uint8_t *bytes_ptr,
uintptr_t bytes_len);
intptr_t connector_sync(Connector *connector, int64_t timeout_millis);
/**
* Given an initialized protocol description, initializes `out` with a clone which can be independently created or destroyed.
*/
Arc_ProtocolDescription *protocol_description_clone(const Arc_ProtocolDescription *pd);
/**
* Destroys the given initialized protocol description and frees its resources.
*/
void protocol_description_destroy(Arc_ProtocolDescription *pd);
/**
* Parses the utf8-encoded string slice to initialize a new protocol description object.
* - On success, initializes `out` and returns 0
* - On failure, stores an error string (see `reowolf_error_peek`) and returns -1
*/
Arc_ProtocolDescription *protocol_description_parse(const uint8_t *pdl, uintptr_t pdl_len);
/**
* Returns length (via out pointer) and pointer (via return value) of the last Reowolf error.
* - pointer is NULL iff there was no last error
* - data at pointer is null-delimited
* - len does NOT include the length of the null-delimiter
* If len is NULL, it will not written to.
*/
const uint8_t *reowolf_error_peek(uintptr_t *len);
#endif /* REOWOLF_HEADER_DEFINED */
/* CBindgen generated */
#ifndef REOWOLF_HEADER_DEFINED
#define REOWOLF_HEADER_DEFINED
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
typedef enum {
EndpointPolarity_Active,
EndpointPolarity_Passive,
} EndpointPolarity;
typedef enum {
Polarity_Putter,
Polarity_Getter,
} Polarity;
typedef struct Arc_ProtocolDescription Arc_ProtocolDescription;
typedef struct Connector Connector;
typedef int32_t ErrorCode;
typedef uint32_t ConnectorId;
typedef uint32_t PortSuffix;
typedef struct {
ConnectorId connector_id;
PortSuffix u32_suffix;
} Id;
typedef Id PortId;
/**
* Given
* - an initialized connector in setup or connecting state,
* - a string slice for the component's identifier in the connector's configured protocol description,
* - a set of ports (represented as a slice; duplicates are ignored) in the native component's interface,
* the connector creates a new (internal) protocol component C, such that the set of native ports are moved to C.
* Usable in {setup, communication} states.
*/
ErrorCode connector_add_component(Connector *connector,
const uint8_t *ident_ptr,
uintptr_t ident_len,
const PortId *ports_ptr,
uintptr_t ports_len);
/**
* Given
* - an initialized connector in setup or connecting state,
* - a utf-8 encoded socket address,
* - the logical polarity of P,
* - the "physical" polarity in {Active, Passive} of the endpoint through which P's peer will be discovered,
* returns P, a port newly added to the native interface.
*/
ErrorCode connector_add_net_port(Connector *connector,
PortId *port,
const uint8_t *addr_str_ptr,
uintptr_t addr_str_len,
Polarity port_polarity,
EndpointPolarity endpoint_polarity);
/**
* Given an initialized connector in setup or connecting state,
* - Creates a new directed port pair with logical channel putter->getter,
* - adds the ports to the native component's interface,
* - and returns them using the given out pointers.
* Usable in {setup, communication} states.
*/
void connector_add_port_pair(Connector *connector, PortId *out_putter, PortId *out_getter);
/**
* Given
* - an initialized connector in setup or connecting state,
* - a utf-8 encoded BIND socket addresses (i.e., "local"),
* - a utf-8 encoded CONNECT socket addresses (i.e., "peer"),
* returns [P, G] via out pointers [putter, getter],
* - where P is a Putter port that sends messages into the socket
* - where G is a Getter port that recvs messages from the socket
*/
ErrorCode connector_add_udp_port(Connector *connector,
PortId (*putter)[2],
const uint8_t *local_addr_str_ptr,
uintptr_t local_addr_str_len,
const uint8_t *peer_addr_str_ptr,
uintptr_t peer_addr_str_len);
/**
* Connects this connector to the distributed system of connectors reachable through endpoints,
* Usable in setup state, and changes the state to communication.
*/
ErrorCode connector_connect(Connector *connector, int64_t timeout_millis);
/**
* Destroys the given a pointer to the connector on the heap, freeing its resources.
* Usable in {setup, communication} states.
*/
void connector_destroy(Connector *connector);
ErrorCode connector_get(Connector *connector, PortId port);
const uint8_t *connector_gotten_bytes(Connector *connector, PortId port, uintptr_t *out_len);
/**
* Initializes `out` with a new connector using the given protocol description as its configuration.
* The connector uses the given (internal) connector ID.
*/
Connector *connector_new(const Arc_ProtocolDescription *pd);
Connector *connector_new_logging(const Arc_ProtocolDescription *pd,
const uint8_t *path_ptr,
uintptr_t path_len);
intptr_t connector_next_batch(Connector *connector);
void connector_print_debug(Connector *connector);
/**
* Convenience function combining the functionalities of
* "payload_new" with "connector_put_payload".
*/
ErrorCode connector_put_bytes(Connector *connector,
PortId port,
const uint8_t *bytes_ptr,
uintptr_t bytes_len);
intptr_t connector_sync(Connector *connector, int64_t timeout_millis);
/**
* Given an initialized protocol description, initializes `out` with a clone which can be independently created or destroyed.
*/
Arc_ProtocolDescription *protocol_description_clone(const Arc_ProtocolDescription *pd);
/**
* Destroys the given initialized protocol description and frees its resources.
*/
void protocol_description_destroy(Arc_ProtocolDescription *pd);
/**
* Parses the utf8-encoded string slice to initialize a new protocol description object.
* - On success, initializes `out` and returns 0
* - On failure, stores an error string (see `reowolf_error_peek`) and returns -1
*/
Arc_ProtocolDescription *protocol_description_parse(const uint8_t *pdl, uintptr_t pdl_len);
/**
* Returns length (via out pointer) and pointer (via return value) of the last Reowolf error.
* - pointer is NULL iff there was no last error
* - data at pointer is null-delimited
* - len does NOT include the length of the null-delimiter
* If len is NULL, it will not written to.
*/
const uint8_t *reowolf_error_peek(uintptr_t *len);
#endif /* REOWOLF_HEADER_DEFINED */
/* CBindgen generated */
#ifndef REOWOLF_HEADER_DEFINED
#define REOWOLF_HEADER_DEFINED
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
typedef enum {
EndpointPolarity_Active,
EndpointPolarity_Passive,
} EndpointPolarity;
typedef enum {
Polarity_Putter,
Polarity_Getter,
} Polarity;
typedef struct Arc_ProtocolDescription Arc_ProtocolDescription;
typedef struct Connector Connector;
typedef int ErrorCode;
typedef uint32_t ConnectorId;
typedef uint32_t PortSuffix;
typedef struct {
ConnectorId connector_id;
PortSuffix u32_suffix;
} Id;
typedef Id PortId;
/**
* Given
* - an initialized connector in setup or connecting state,
* - a string slice for the component's identifier in the connector's configured protocol description,
* - a set of ports (represented as a slice; duplicates are ignored) in the native component's interface,
* the connector creates a new (internal) protocol component C, such that the set of native ports are moved to C.
* Usable in {setup, communication} states.
*/
ErrorCode connector_add_component(Connector *connector,
const uint8_t *ident_ptr,
uintptr_t ident_len,
const PortId *ports_ptr,
uintptr_t ports_len);
/**
* Given
* - an initialized connector in setup or connecting state,
* - a utf-8 encoded socket address,
* - the logical polarity of P,
* - the "physical" polarity in {Active, Passive} of the endpoint through which P's peer will be discovered,
* returns P, a port newly added to the native interface.
*/
ErrorCode connector_add_net_port(Connector *connector,
PortId *port,
const uint8_t *addr_str_ptr,
uintptr_t addr_str_len,
Polarity port_polarity,
EndpointPolarity endpoint_polarity);
/**
* Given an initialized connector in setup or connecting state,
* - Creates a new directed port pair with logical channel putter->getter,
* - adds the ports to the native component's interface,
* - and returns them using the given out pointers.
* Usable in {setup, communication} states.
*/
void connector_add_port_pair(Connector *connector, PortId *out_putter, PortId *out_getter);
/**
* Given
* - an initialized connector in setup or connecting state,
* - a utf-8 encoded BIND socket addresses (i.e., "local"),
* - a utf-8 encoded CONNECT socket addresses (i.e., "peer"),
* returns [P, G] via out pointers [putter, getter],
* - where P is a Putter port that sends messages into the socket
* - where G is a Getter port that recvs messages from the socket
*/
ErrorCode connector_add_udp_port(Connector *connector,
PortId *putter,
PortId *getter,
const uint8_t *local_addr_str_ptr,
uintptr_t local_addr_str_len,
const uint8_t *peer_addr_str_ptr,
uintptr_t peer_addr_str_len);
/**
* Connects this connector to the distributed system of connectors reachable through endpoints,
* Usable in setup state, and changes the state to communication.
*/
ErrorCode connector_connect(Connector *connector, int64_t timeout_millis);
/**
* Destroys the given a pointer to the connector on the heap, freeing its resources.
* Usable in {setup, communication} states.
*/
void connector_destroy(Connector *connector);
ErrorCode connector_get(Connector *connector, PortId port);
const uint8_t *connector_gotten_bytes(Connector *connector, PortId port, uintptr_t *out_len);
/**
* Initializes `out` with a new connector using the given protocol description as its configuration.
* The connector uses the given (internal) connector ID.
*/
Connector *connector_new(const Arc_ProtocolDescription *pd);
Connector *connector_new_logging(const Arc_ProtocolDescription *pd,
const uint8_t *path_ptr,
uintptr_t path_len);
intptr_t connector_next_batch(Connector *connector);
void connector_print_debug(Connector *connector);
/**
* Convenience function combining the functionalities of
* "payload_new" with "connector_put_payload".
*/
ErrorCode connector_put_bytes(Connector *connector,
PortId port,
const uint8_t *bytes_ptr,
uintptr_t bytes_len);
intptr_t connector_sync(Connector *connector, int64_t timeout_millis);
/**
* Given an initialized protocol description, initializes `out` with a clone which can be independently created or destroyed.
*/
Arc_ProtocolDescription *protocol_description_clone(const Arc_ProtocolDescription *pd);
/**
* Destroys the given initialized protocol description and frees its resources.
*/
void protocol_description_destroy(Arc_ProtocolDescription *pd);
/**
* Parses the utf8-encoded string slice to initialize a new protocol description object.
* - On success, initializes `out` and returns 0
* - On failure, stores an error string (see `reowolf_error_peek`) and returns -1
*/
Arc_ProtocolDescription *protocol_description_parse(const uint8_t *pdl, uintptr_t pdl_len);
/**
* Returns length (via out pointer) and pointer (via return value) of the last Reowolf error.
* - pointer is NULL iff there was no last error
* - data at pointer is null-delimited
* - len does NOT include the length of the null-delimiter
* If len is NULL, it will not written to.
*/
const uint8_t *reowolf_error_peek(uintptr_t *len);
#endif /* REOWOLF_HEADER_DEFINED */
|