- /// Set the poll callback.
- /** This functions sets the callback that is called whenever data can be sent to another node.
- * The callback is run in MeshLink's own thread.
- * It is therefore important that the callback uses apprioriate methods (queues, pipes, locking, etc.)
- * to pass data to or from the application's thread.
- * The callback should also not block itself and return as quickly as possible.
- *
- * @param channel A handle for the channel.
- * @param cb A pointer to the function which will be called when data can be sent to another node.
- * If a NULL pointer is given, the callback will be disabled.
- */
- void set_channel_poll_cb(channel *channel, channel_poll_cb_t cb) {
- meshlink_set_channel_poll_cb(handle, channel, (meshlink_channel_poll_cb_t)cb);
- }
-
- /// Set the send buffer size of a channel.
- /** This function sets the desired size of the send buffer.
- * The default size is 128 kB.
- *
- * @param channel A handle for the channel.
- * @param size The desired size for the send buffer.
- * If a NULL pointer is given, the callback will be disabled.
- */
- void set_channel_sndbuf(channel *channel, size_t size) {
- meshlink_set_channel_sndbuf(handle, channel, size);
- }
-
- /// Set the receive buffer size of a channel.
- /** This function sets the desired size of the receive buffer.
- * The default size is 128 kB.
- *
- * @param channel A handle for the channel.
- * @param size The desired size for the send buffer.
- * If a NULL pointer is given, the callback will be disabled.
- */
- void set_channel_rcvbuf(channel *channel, size_t size) {
- meshlink_set_channel_rcvbuf(handle, channel, size);
- }
-
- /// Set the flags of a channel.
- /** This function allows changing some of the channel flags.
- * Currently only MESHLINK_CHANNEL_NO_PARTIAL and MESHLINK_CHANNEL_DROP_LATE are supported, other flags are ignored.
- * These flags only affect the local side of the channel with the peer.
- * The changes take effect immediately.
- *
- * @param channel A handle for the channel.
- * @param flags A bitwise-or'd combination of flags that set the semantics for this channel.
- */
- void set_channel_flags(channel *channel, uint32_t flags) {
- meshlink_set_channel_flags(handle, channel, flags);
- }
-
- /// Set the send buffer storage of a channel.
- /** This function provides MeshLink with a send buffer allocated by the application.
- *
- * @param channel A handle for the channel.
- * @param buf A pointer to the start of the buffer.
- * If a NULL pointer is given, MeshLink will use its own internal buffer again.
- * @param size The size of the buffer.
- */
- void set_channel_sndbuf_storage(channel *channel, void *buf, size_t size) {
- meshlink_set_channel_sndbuf_storage(handle, channel, buf, size);
- }
-
- /// Set the receive buffer storage of a channel.
- /** This function provides MeshLink with a receive buffer allocated by the application.
- *
- * @param channel A handle for the channel.
- * @param buf A pointer to the start of the buffer.
- * If a NULL pointer is given, MeshLink will use its own internal buffer again.
- * @param size The size of the buffer.
- */
- void set_channel_rcvbuf_storage(channel *channel, void *buf, size_t size) {
- meshlink_set_channel_rcvbuf_storage(handle, channel, buf, size);
- }
-
- /// Set the connection timeout used for channels to the given node.
- /** This sets the timeout after which unresponsive channels will be reported as closed.
- * The timeout is set for all current and future channels to the given node.
- *
- * @param node The node to set the channel timeout for.
- * @param timeout The timeout in seconds after which unresponsive channels will be reported as closed.
- * The default is 60 seconds.
- */
- void set_node_channel_timeout(node *node, int timeout) {
- meshlink_set_node_channel_timeout(handle, node, timeout);
- }
-
- /// Open a reliable stream channel to another node.
- /** This function is called whenever a remote node wants to open a channel to the local node.
- * The application then has to decide whether to accept or reject this channel.
- *
- * This function sets the channel poll callback to channel_poll_trampoline, which in turn
- * calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
- *
- * @param node The node to which this channel is being initiated.
- * @param port The port number the peer wishes to connect to.
- * @param cb A pointer to the function which will be called when the remote node sends data to the local node.
- * @param data A pointer to a buffer containing data to already queue for sending.
- * @param len The length of the data.
- * If len is 0, the data pointer is copied into the channel's priv member.
- * @param flags A bitwise-or'd combination of flags that set the semantics for this channel.
- *
- * @return A handle for the channel, or NULL in case of an error.
- */
- channel *channel_open(node *node, uint16_t port, channel_receive_cb_t cb, const void *data, size_t len, uint32_t flags = channel::TCP) {
- channel *ch = (channel *)meshlink_channel_open_ex(handle, node, port, (meshlink_channel_receive_cb_t)cb, data, len, flags);
- meshlink_set_channel_poll_cb(handle, ch, &channel_poll_trampoline);
- return ch;
- }
-
- /// Open a reliable stream channel to another node.
- /** This function is called whenever a remote node wants to open a channel to the local node.
- * The application then has to decide whether to accept or reject this channel.
- *
- * This function sets the channel receive callback to channel_receive_trampoline,
- * which in turn calls channel_receive.
- *
- * This function sets the channel poll callback to channel_poll_trampoline, which in turn
- * calls channel_poll. To set a different, channel-specific poll callback, use set_channel_poll_cb.
- *
- * @param node The node to which this channel is being initiated.
- * @param port The port number the peer wishes to connect to.
- * @param data A pointer to a buffer containing data to already queue for sending.
- * @param len The length of the data.
- * If len is 0, the data pointer is copied into the channel's priv member.
- * @param flags A bitwise-or'd combination of flags that set the semantics for this channel.
- *
- * @return A handle for the channel, or NULL in case of an error.
- */
- channel *channel_open(node *node, uint16_t port, const void *data, size_t len, uint32_t flags = channel::TCP) {
- channel *ch = (channel *)meshlink_channel_open_ex(handle, node, port, &channel_receive_trampoline, data, len, flags);
- meshlink_set_channel_poll_cb(handle, ch, &channel_poll_trampoline);
- return ch;
- }
-
- /// Partially close a reliable stream channel.
- /** This shuts down the read or write side of a channel, or both, without closing the handle.
- * It can be used to inform the remote node that the local node has finished sending all data on the channel,
- * but still allows waiting for incoming data from the remote node.
- *
- * @param channel A handle for the channel.
- * @param direction Must be one of SHUT_RD, SHUT_WR or SHUT_RDWR.
- */
- void channel_shutdown(channel *channel, int direction) {
- return meshlink_channel_shutdown(handle, channel, direction);
- }
-
- /// Close a reliable stream channel.
- /** This informs the remote node that the local node has finished sending all data on the channel.
- * It also causes the local node to stop accepting incoming data from the remote node.
- * Afterwards, the channel handle is invalid and must not be used any more.
- *
- * It is allowed to call this function at any time on a valid handle, even inside callback functions.
- * If called with a valid handle, this function always succeeds, otherwise the result is undefined.
- *
- * @param channel A handle for the channel.
- */
- void channel_close(meshlink_channel_t *channel) {
- return meshlink_channel_close(handle, channel);
- }
-
- /// Abort a reliable stream channel.
- /** This aborts a channel.
- * Data that was in the send and receive buffers is dropped, so potentially there is some data that
- * was sent on this channel that will not be received by the peer.
- * Afterwards, the channel handle is invalid and must not be used any more.
- *
- * It is allowed to call this function at any time on a valid handle, even inside callback functions.
- * If called with a valid handle, this function always succeeds, otherwise the result is undefined.
- *
- * @param channel A handle for the channel.
- */
- void channel_abort(meshlink_channel_t *channel) {
- return meshlink_channel_abort(handle, channel);
- }
-
- /// Transmit data on a channel
- /** This queues data to send to the remote node.
- *
- * @param channel A handle for the channel.
- * @param data A pointer to a buffer containing data sent by the source.
- * @param len The length of the data.
- *
- * @return The amount of data that was queued, which can be less than len, or a negative value in case of an error.
- * If MESHLINK_CHANNEL_NO_PARTIAL is set, then the result will either be len,
- * 0 if the buffer is currently too full, or -1 if len is too big even for an empty buffer.
- */
- ssize_t channel_send(channel *channel, void *data, size_t len) {
- return meshlink_channel_send(handle, channel, data, len);
- }
-
- /// Transmit data on a channel asynchronously
- /** This registers a buffer that will be used to send data to the remote node.
- * Multiple buffers can be registered, in which case data will be sent in the order the buffers were registered.
- * While there are still buffers with unsent data, the poll callback will not be called.
- *
- * @param channel A handle for the channel.
- * @param data A pointer to a buffer containing data sent by the source, or NULL if there is no data to send.
- * After meshlink_channel_aio_send() returns, the buffer may not be modified or freed by the application
- * until the callback routine is called.
- * @param len The length of the data, or 0 if there is no data to send.
- * @param cb A pointer to the function which will be called when MeshLink has finished using the buffer.
- * @param priv A private pointer which was set by the application when submitting the buffer.
- *
- * @return True if the buffer was enqueued, false otherwise.
- */
- bool channel_aio_send(channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) {
- return meshlink_channel_aio_send(handle, channel, data, len, cb, priv);
- }
-
- /// Transmit data on a channel asynchronously from a filedescriptor
- /** This will read up to the specified length number of bytes from the given filedescriptor, and send it over the channel.
- * The callback may be returned early if there is an error reading from the filedescriptor.
- * While there is still with unsent data, the poll callback will not be called.
- *
- * @param channel A handle for the channel.
- * @param fd A file descriptor from which data will be read.
- * @param len The length of the data, or 0 if there is no data to send.
- * @param cb A pointer to the function which will be called when MeshLink has finished using the filedescriptor.
- * @param priv A private pointer which was set by the application when submitting the buffer.
- *
- * @return True if the buffer was enqueued, false otherwise.
- */
- bool channel_aio_fd_send(channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) {
- return meshlink_channel_aio_fd_send(handle, channel, fd, len, cb, priv);
- }
-
- /// Receive data on a channel asynchronously
- /** This registers a buffer that will be filled with incoming channel data.
- * Multiple buffers can be registered, in which case data will be received in the order the buffers were registered.
- * While there are still buffers that have not been filled, the receive callback will not be called.
- *
- * @param channel A handle for the channel.
- * @param data A pointer to a buffer that will be filled with incoming data.
- * After meshlink_channel_aio_receive() returns, the buffer may not be modified or freed by the application
- * until the callback routine is called.
- * @param len The length of the data.
- * @param cb A pointer to the function which will be called when MeshLink has finished using the buffer.
- * @param priv A private pointer which was set by the application when submitting the buffer.
- *
- * @return True if the buffer was enqueued, false otherwise.
- */
- bool channel_aio_receive(channel *channel, const void *data, size_t len, meshlink_aio_cb_t cb, void *priv) {
- return meshlink_channel_aio_receive(handle, channel, data, len, cb, priv);
- }
-
- /// Receive data on a channel asynchronously and send it to a filedescriptor
- /** This will read up to the specified length number of bytes from the channel, and send it to the filedescriptor.
- * The callback may be returned early if there is an error writing to the filedescriptor.
- * While there is still unread data, the receive callback will not be called.
- *
- * @param channel A handle for the channel.
- * @param fd A file descriptor to which data will be written.
- * @param len The length of the data.
- * @param cb A pointer to the function which will be called when MeshLink has finished using the filedescriptor.
- * @param priv A private pointer which was set by the application when submitting the buffer.
- *
- * @return True if the buffer was enqueued, false otherwise.
- */
- bool channel_aio_fd_receive(channel *channel, int fd, size_t len, meshlink_aio_fd_cb_t cb, void *priv) {
- return meshlink_channel_aio_fd_receive(handle, channel, fd, len, cb, priv);
- }
-
- /// Get the amount of bytes in the send buffer.
- /** This returns the amount of bytes in the send buffer.
- * These bytes have not been received by the peer yet.
- *
- * @param channel A handle for the channel.
- *
- * @return The amount of un-ACKed bytes in the send buffer.
- */
- size_t channel_get_sendq(channel *channel) {
- return meshlink_channel_get_sendq(handle, channel);
- }
-
- /// Get the amount of bytes in the receive buffer.
- /** This returns the amount of bytes in the receive buffer.
- * These bytes have not been processed by the application yet.
- *
- * @param channel A handle for the channel.
- *
- * @return The amount of bytes in the receive buffer.
- */
- size_t channel_get_recvq(channel *channel) {
- return meshlink_channel_get_recvq(handle, channel);
- }
-
- /// Get the maximum segment size of a channel.
- /** This returns the amount of bytes that can be sent at once for channels with UDP semantics.
- *
- * @param channel A handle for the channel.
- *
- * @return The amount of bytes in the receive buffer.
- */
- size_t channel_get_mss(channel *channel) {
- return meshlink_channel_get_mss(handle, channel);
- };
-