X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=src%2Fmeshlink-tiny.h;h=131dc8e49d8cb2f708f2c982d848a597cc1926d7;hb=b549eb9642b4b8b441b0e23cd3e0b4d7f39907ae;hp=a13e627fb6bc200830a4cda4e9d8e50097dd37e3;hpb=86a858b3f9aa659c0d8c411c61f0ac2eeb3a2882;p=meshlink-tiny diff --git a/src/meshlink-tiny.h b/src/meshlink-tiny.h index a13e627..131dc8e 100644 --- a/src/meshlink-tiny.h +++ b/src/meshlink-tiny.h @@ -869,105 +869,6 @@ bool meshlink_set_canonical_address(struct meshlink_handle *mesh, struct meshlin */ bool meshlink_clear_canonical_address(struct meshlink_handle *mesh, struct meshlink_node *node) __attribute__((__warn_unused_result__)); -/// 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 meshlink_set_canonical_address() and/or meshlink_add_invitation_address(). - * - * \memberof meshlink_handle - * @param mesh A handle which represents an instance of MeshLink. - * @param address A nul-terminated C 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 meshlink_add_address(struct meshlink_handle *mesh, const char *address) __attribute__((__warn_unused_result__, __deprecated__("use meshlink_set_canonical_address() and/or meshlink_add_invitation_address() instead"))); - -/// Try to discover the external address for the local node. -/** 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. - * - * \memberof meshlink_handle - * @param mesh A handle which represents an instance of MeshLink. - * - * @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 meshlink_get_external_address() returns, the application is free to overwrite or free this string. - */ -char *meshlink_get_external_address(struct meshlink_handle *mesh) __attribute__((__warn_unused_result__)); - -/// Try to discover the external address for the local node. -/** 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. - * - * \memberof meshlink_handle - * @param mesh A handle which represents an instance of MeshLink. - * @param address_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 meshlink_get_external_address_for_family() returns, the application is free to overwrite or free this string. - */ -char *meshlink_get_external_address_for_family(struct meshlink_handle *mesh, int address_family) __attribute__((__warn_unused_result__)); - -/// Try to discover the local address for the local node. -/** 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 interface might have more than one address. - * In that case, there is no control over which address will be selected. - * Also note that if you have a dynamic IP address, - * there is no guarantee that the local 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. - * - * \memberof meshlink_handle - * @param mesh A handle which represents an instance of MeshLink. - * @param address_family The address family to check, for example AF_INET or AF_INET6. If AF_UNSPEC is given, - * this might return the local address for any working address family. - * - * @return This function returns a pointer to a C string containing the discovered local address, - * or NULL if there was an error looking up the address. - * After meshlink_get_local_address_for_family() returns, the application is free to overwrite or free this string. - */ -char *meshlink_get_local_address_for_family(struct meshlink_handle *mesh, int address_family) __attribute__((__warn_unused_result__)); - -/// Try to discover the external address for the local node, and add it to its list of addresses. -/** This function is equivalent to: - * - * meshlink_set_canonical_address(mesh, meshlink_get_self(mesh), meshlink_get_external_address(mesh), NULL); - * - * Read the description of meshlink_get_external_address() for the limitations of this function. - * - * \memberof meshlink_handle - * @param mesh A handle which represents an instance of MeshLink. - * - * @return This function returns true if the address was added, false otherwise. - */ -bool meshlink_add_external_address(struct meshlink_handle *mesh) __attribute__((__warn_unused_result__)); - /** This function allows the local node to join an existing mesh using an invitation URL generated by another node. * An invitation can only be used if the local node has never connected to other nodes before. * After a successfully accepted invitation, the name of the local node may have changed.