class mesh;
class node;
class channel;
-class submesh;
/// Severity of log messages generated by MeshLink.
typedef meshlink_log_level_t log_level_t;
*/
typedef void (*node_status_cb_t)(mesh *mesh, node *node, bool reachable);
-/// A callback reporting node path MTU changes.
-/** @param mesh A handle which represents an instance of MeshLink.
- * @param node A pointer to a meshlink_node_t describing the node whose status changed.
- * This pointer is valid until meshlink_close() is called.
- * @param pmtu The current path MTU to the node, or 0 if UDP communication is not (yet) possible.
- */
-typedef void (*node_pmtu_cb_t)(mesh *mesh, node *node, uint16_t pmtu);
-
/// A callback reporting duplicate node detection.
/** @param mesh A handle which represents an instance of MeshLink.
* @param node A pointer to a meshlink_node_t describing the node which is duplicate.
*/
typedef void (*channel_poll_cb_t)(mesh *mesh, channel *channel, size_t len);
-/// A callback for cleaning up buffers submitted for asynchronous I/O.
-/** This callbacks signals that MeshLink has finished using this buffer.
- * The ownership of the buffer is now back into the application's hands.
- *
- * @param mesh A handle which represents an instance of MeshLink.
- * @param channel A handle for the channel which used this buffer.
- * @param data A pointer to a buffer containing the enqueued data.
- * @param len The length of the buffer.
- * @param priv A private pointer which was set by the application when submitting the buffer.
- */
-typedef void (*aio_cb_t)(mesh *mesh, channel *channel, const void *data, size_t len, void *priv);
-
-/// A callback for asynchronous I/O to and from filedescriptors.
-/** This callbacks signals that MeshLink has finished using this filedescriptor.
- *
- * @param mesh A handle which represents an instance of MeshLink.
- * @param channel A handle for the channel which used this filedescriptor.
- * @param fd The filedescriptor that was used.
- * @param len The length of the data that was successfully sent or received.
- * @param priv A private pointer which was set by the application when submitting the buffer.
- */
-typedef void (*aio_fd_cb_t)(mesh *mesh, channel *channel, int fd, size_t len, void *priv);
-
/// A class describing a MeshLink node.
class node: public meshlink_node_t {
};
-/// A class describing a MeshLink Sub-Mesh.
-class submesh: public meshlink_submesh_t {
-};
-
/// A class describing a MeshLink channel.
class channel: public meshlink_channel_t {
public:
(void)reachable;
}
- /// This functions is called whenever another node's path MTU changes.
- virtual void node_pmtu(node *peer, uint16_t pmtu) {
- /* do nothing */
- (void)peer;
- (void)pmtu;
- }
-
/// This functions is called whenever a duplicate node is detected.
virtual void node_duplicate(node *peer) {
/* do nothing */
bool start() {
meshlink_set_receive_cb(handle, &receive_trampoline);
meshlink_set_node_status_cb(handle, &node_status_trampoline);
- meshlink_set_node_pmtu_cb(handle, &node_pmtu_trampoline);
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);
return meshlink_get_node_reachability(handle, node, last_reachable, last_unreachable);
}
- /// Get a handle for a specific submesh.
- /** This function returns a handle for the submesh with the given name.
- *
- * @param name The name of the submesh for which a handle is requested.
- *
- * @return A pointer to a meshlink::submesh which represents the requested submesh,
- * or NULL if the requested submesh does not exist.
- */
- submesh *get_submesh(const char *name) {
- return (submesh *)meshlink_get_submesh(handle, name);
- }
-
/// Get a handle for our own node.
/** This function returns a handle for the local node.
*
return meshlink_clear_canonical_address(handle, node);
}
- /// Add an Address for the local node.
- /** This function adds an Address for the local node, which will be used for invitation URLs.
- * @deprecated This function is deprecated, use set_canonical_address() and/or add_invitation_address().
- *
- * @param address A string containing the address, which can be either in numeric format or a hostname.
- *
- * @return This function returns true if the address was added, false otherwise.
- */
- bool add_address(const char *address) __attribute__((__deprecated__("use set_canonical_address() and/or add_invitation_address() instead"))) {
- return meshlink_set_canonical_address(handle, get_self(), address, NULL);
- }
-
- /** This function performs tries to discover the local node's external address
- * by contacting the meshlink.io server. If a reverse lookup of the address works,
- * the FQDN associated with the address will be returned.
- *
- * Please note that this is function only returns a single address,
- * even if the local node might have more than one external address.
- * In that case, there is no control over which address will be selected.
- * Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
- * there is no guarantee that the external address will be valid for an extended period of time.
- *
- * This function is blocking. It can take several seconds before it returns.
- * There is no guarantee it will be able to resolve the external address.
- * Failures might be because by temporary network outages.
- *
- * @param family The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
- * this might return the external address for any working address family.
- *
- * @return This function returns a pointer to a C string containing the discovered external address,
- * or NULL if there was an error looking up the address.
- * After get_external_address() returns, the application is free to overwrite or free this string.
- */
- bool get_external_address(int family = AF_UNSPEC) {
- return meshlink_get_external_address_for_family(handle, family);
- }
-
- /** This function performs tries to discover the address of the local interface used for outgoing connection.
- *
- * Please note that this is function only returns a single address,
- * even if the local node might have more than one external address.
- * In that case, there is no control over which address will be selected.
- * Also note that if you have a dynamic IP address, or are behind carrier-grade NAT,
- * there is no guarantee that the external address will be valid for an extended period of time.
- *
- * This function will fail if it couldn't find a local address for the given address family.
- * If hostname resolving is requested, this function may block for a few seconds.
- *
- * @param family The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given,
- * this might return the external address for any working address family.
- *
- * @return This function returns a pointer to a C string containing the discovered external address,
- * or NULL if there was an error looking up the address.
- * After get_external_address() returns, the application is free to overwrite or free this string.
- */
- bool get_local_address(int family = AF_UNSPEC) {
- return meshlink_get_local_address_for_family(handle, family);
- }
-
- /// Try to discover the external address for the local node, and add it to its list of addresses.
- /** This function is equivalent to:
- *
- * mesh->add_address(mesh->get_external_address());
- *
- * Read the description of get_external_address() for the limitations of this function.
- *
- * @return This function returns true if the address was added, false otherwise.
- */
- bool add_external_address() {
- return meshlink_add_external_address(handle);
- }
-
- /// Get the network port used by the local node.
- /** This function returns the network port that the local node is listening on.
- *
- * @return This function returns the port number, or -1 in case of an error.
- */
- int get_port() {
- return meshlink_get_port(handle);
- }
-
- /// Set the network port used by the local node.
- /** This function sets the network port that the local node is listening on.
- * It may only be called when the mesh is not running.
- * If unsure, call stop() before calling this function.
- * Also note that if your node is already part of a mesh with other nodes,
- * that the other nodes may no longer be able to initiate connections to the local node,
- * since they will try to connect to the previously configured port.
- *
- * @param port The port number to listen on. This must be between 0 and 65535.
- * If the port is set to 0, then MeshLink will listen on a port
- * that is randomly assigned by the operating system every time open() is called.
- *
- * @return This function returns true if the port was successfully changed
- * to the desired port, false otherwise. If it returns false, there
- * is no guarantee that MeshLink is listening on the old port.
- */
- bool set_port(int port) {
- return meshlink_set_port(handle, port);
- }
-
/// Set the scheduling granularity of the application
/** This should be set to the effective scheduling granularity for the application.
* This depends on the scheduling granularity of the operating system, the application's
return meshlink_forget_node(handle, node);
}
- /// 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.
*/
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;
}
*/
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;
}
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.
that->node_status(static_cast<node *>(peer), reachable);
}
- static void node_pmtu_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer, uint16_t pmtu) {
- if(!(handle->priv)) {
- return;
- }
-
- meshlink::mesh *that = static_cast<mesh *>(handle->priv);
- that->node_pmtu(static_cast<node *>(peer), pmtu);
- }
-
static void node_duplicate_trampoline(meshlink_handle_t *handle, meshlink_node_t *peer) {
if(!(handle->priv)) {
return;
if(accepted) {
meshlink_set_channel_receive_cb(handle, channel, &channel_receive_trampoline);
- meshlink_set_channel_poll_cb(handle, channel, &channel_poll_trampoline);
}
return accepted;
projects / meshlink-tiny / blobdiff