namespace meshlink {
class mesh;
class node;
-class channel;
/// Severity of log messages generated by MeshLink.
typedef meshlink_log_level_t log_level_t;
*/
typedef void (*log_cb_t)(mesh *mesh, log_level_t level, const char *text);
-/// A callback for listening for incoming channels.
-/** @param mesh A handle which represents an instance of MeshLink.
- * @param node A handle for the node that wants to open a channel.
- * @param port The port number the peer wishes to connect to.
- *
- * @return This function should return true if the application listens for the incoming channel, false otherwise.
- */
-typedef bool (*meshlink_channel_listen_cb_t)(struct meshlink_handle *mesh, struct meshlink_node *node, uint16_t port);
-
-/// A callback for accepting incoming channels.
-/** @param mesh A handle which represents an instance of MeshLink.
- * @param channel A handle for the incoming channel.
- * @param port The port number the peer wishes to connect to.
- * @param data A pointer to a buffer containing data already received. (Not yet used.)
- * @param len The length of the data. (Not yet used.)
- *
- * @return This function should return true if the application accepts the incoming channel, false otherwise.
- * If returning false, the channel is invalid and may not be used anymore.
- */
-typedef bool (*channel_accept_cb_t)(mesh *mesh, channel *channel, uint16_t port, const void *data, size_t len);
-
-/// A callback for receiving data from a channel.
-/** @param mesh A handle which represents an instance of MeshLink.
- * @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.
- */
-typedef void (*channel_receive_cb_t)(mesh *mesh, channel *channel, const void *data, size_t len);
-
-/// A callback that is called when data can be send on a channel.
-/** @param mesh A handle which represents an instance of MeshLink.
- * @param channel A handle for the channel.
- * @param len The maximum length of data that is guaranteed to be accepted by a call to channel_send().
- */
-typedef void (*channel_poll_cb_t)(mesh *mesh, channel *channel, size_t len);
-
/// A class describing a MeshLink node.
class node: public meshlink_node_t {
};
-/// A class describing a MeshLink channel.
-class channel: public meshlink_channel_t {
-public:
- static const uint32_t RELIABLE = MESHLINK_CHANNEL_RELIABLE;
- static const uint32_t ORDERED = MESHLINK_CHANNEL_ORDERED;
- static const uint32_t FRAMED = MESHLINK_CHANNEL_FRAMED;
- static const uint32_t DROP_LATE = MESHLINK_CHANNEL_DROP_LATE;
- static const uint32_t NO_PARTIAL = MESHLINK_CHANNEL_NO_PARTIAL;
- static const uint32_t TCP = MESHLINK_CHANNEL_TCP;
- static const uint32_t UDP = MESHLINK_CHANNEL_UDP;
-};
-
/// A class describing a MeshLink mesh.
class mesh {
public:
(void)peer;
}
- /// This functions is called to determine if we are listening for incoming channels.
- /**
- * The function 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 node A handle for the node that wants to open a channel.
- * @param port The port number the peer wishes to connect to.
- *
- * @return This function should return true if the application accepts the incoming channel, false otherwise.
- */
- virtual bool channel_listen(node *node, uint16_t port) {
- /* by default accept all channels */
- (void)node;
- (void)port;
- return true;
- }
-
- /// This functions is called whenever another node attempts to open a channel to the local node.
- /**
- * If the channel is accepted, the poll_callback will be set to channel_poll and can be
- * changed using set_channel_poll_cb(). Likewise, the receive callback is set to
- * channel_receive().
- *
- * The function 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 incoming channel.
- * @param port The port number the peer wishes to connect to.
- * @param data A pointer to a buffer containing data already received. (Not yet used.)
- * @param len The length of the data. (Not yet used.)
- *
- * @return This function should return true if the application accepts the incoming channel, false otherwise.
- * If returning false, the channel is invalid and may not be used anymore.
- */
- virtual bool channel_accept(channel *channel, uint16_t port, const void *data, size_t len) {
- /* by default reject all channels */
- (void)channel;
- (void)port;
- (void)data;
- (void)len;
- return false;
- }
-
- /// This function is called by Meshlink for receiving data from a channel.
- /**
- * The function 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 data A pointer to a buffer containing data sent by the source.
- * @param len The length of the data.
- */
- virtual void channel_receive(channel *channel, const void *data, size_t len) {
- /* do nothing */
- (void)channel;
- (void)data;
- (void)len;
- }
-
- /// This function is called by Meshlink when data can be send on a channel.
- /**
- * The function 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 len The maximum length of data that is guaranteed to be accepted by a call to channel_send().
- */
- virtual void channel_poll(channel *channel, size_t len) {
- /* do nothing */
- (void)channel;
- (void)len;
- }
-
/// Start MeshLink.
/** This function causes MeshLink to open network sockets, make outgoing connections, and
* create a new thread, which will handle all network I/O.
meshlink_set_node_duplicate_cb(handle, &node_duplicate_trampoline);
meshlink_set_log_cb(handle, MESHLINK_DEBUG, &log_trampoline);
meshlink_set_error_cb(handle, &error_trampoline);
- meshlink_set_channel_listen_cb(handle, &channel_listen_trampoline);
- meshlink_set_channel_accept_cb(handle, &channel_accept_trampoline);
meshlink_set_connection_try_cb(handle, &connection_try_trampoline);
return meshlink_start(handle);
}
/** This function allows the local node to forget any information it has about a node,
* and if possible will remove any data it has stored on disk about the node.
*
- * Any open channels to this node must be closed before calling this function.
- *
* After this call returns, the node handle is invalid and may no longer be used, regardless
* of the return value of this call.
*
return meshlink_forget_node(handle, node);
}
- /// 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 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);
- 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);
- 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);
- }
-
- /// 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);
- };
-
/// Inform MeshLink that the local network configuration might have changed
/** This is intended to be used when there is no way for MeshLink to get notifications of local network changes.
* It forces MeshLink to scan all network interfaces for changes in up/down status and new/removed addresses,
that->connection_try(static_cast<node *>(peer));
}
- static bool channel_listen_trampoline(meshlink_handle_t *handle, meshlink_node_t *node, uint16_t port) {
- if(!(handle->priv)) {
- return false;
- }
-
- meshlink::mesh *that = static_cast<mesh *>(handle->priv);
- return that->channel_listen(static_cast<meshlink::node *>(node), port);
- }
-
- static bool channel_accept_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, uint16_t port, const void *data, size_t len) {
- if(!(handle->priv)) {
- return false;
- }
-
- meshlink::mesh *that = static_cast<mesh *>(handle->priv);
- bool accepted = that->channel_accept(static_cast<meshlink::channel *>(channel), port, data, len);
-
- if(accepted) {
- meshlink_set_channel_receive_cb(handle, channel, &channel_receive_trampoline);
- }
-
- return accepted;
- }
-
- static void channel_receive_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, const void *data, size_t len) {
- if(!(handle->priv)) {
- return;
- }
-
- meshlink::mesh *that = static_cast<mesh *>(handle->priv);
- that->channel_receive(static_cast<meshlink::channel *>(channel), data, len);
- }
-
- static void channel_poll_trampoline(meshlink_handle_t *handle, meshlink_channel *channel, size_t len) {
- if(!(handle->priv)) {
- return;
- }
-
- meshlink::mesh *that = static_cast<mesh *>(handle->priv);
- that->channel_poll(static_cast<meshlink::channel *>(channel), len);
- }
-
meshlink_handle_t *handle;
};
projects / meshlink-tiny / blobdiff