Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: TYBLE16_simple_data_logger TYBLE16_MP3_Air
WisunInterface Class Reference
Wi-SUN mesh network interface class. More...
#include <WisunInterface.h>
Inherits MeshInterfaceNanostack.
Public Types | |
typedef mbed::Callback< void(nsapi_error_t result, SocketAddress *address) | hostbyname_cb_t ) |
Hostname translation callback (for use with gethostbyname_async()). | |
Public Member Functions | |
WisunInterface () | |
Create an uninitialized WisunInterface. | |
WisunInterface (NanostackRfPhy *phy) | |
Create an initialized WisunInterface. | |
mesh_error_t | set_network_name (char *network_name) |
Set Wi-SUN network name. | |
mesh_error_t | set_network_regulatory_domain (uint8_t regulatory_domain=0xff, uint8_t operating_class=0xff, uint8_t operating_mode=0xff) |
Set Wi-SUN network regulatory domain, operating class and operating mode. | |
mesh_error_t | set_own_certificate (uint8_t *cert, uint16_t cert_len, uint8_t *cert_key=NULL, uint16_t cert_key_len=0) |
Set own certificate and private key reference to the Wi-SUN network. | |
mesh_error_t | remove_own_certificates (void) |
Remove own certificates from the Wi-SUN network. | |
mesh_error_t | set_trusted_certificate (uint8_t *cert, uint16_t cert_len) |
Set trusted certificate reference to the Wi-SUN network. | |
mesh_error_t | remove_trusted_certificates (void) |
Remove trusted certificates from the Wi-SUN network. | |
bool | getRouterIpAddress (char *address, int8_t len) |
Get router IP address. | |
nsapi_error_t | initialize (NanostackRfPhy *phy) |
Attach phy and initialize the mesh. | |
virtual nsapi_error_t | connect () |
Start the interface. | |
virtual nsapi_error_t | disconnect () |
Stop the interface. | |
virtual nsapi_error_t | get_ip_address (SocketAddress *address) |
virtual const char * | get_mac_address () |
Get the internally stored MAC address /return MAC address of the interface. | |
virtual void | attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb) |
Register callback for status reporting. | |
virtual nsapi_connection_status_t | get_connection_status () const |
Get the connection status. | |
virtual nsapi_error_t | set_blocking (bool blocking) |
Set blocking status of connect() which by default should be blocking. | |
virtual nsapi_error_t | set_file_system_root_path (const char *root_path) |
Set file system root path. | |
int8_t | get_interface_id () const |
Get the interface ID. | |
virtual void | set_as_default () |
Set network interface as default one. | |
virtual nsapi_error_t | get_ipv6_link_local_address (SocketAddress *address) |
Get the IPv6 link local address. | |
virtual nsapi_error_t | get_netmask (SocketAddress *address) |
Get the local network mask. | |
virtual nsapi_error_t | get_gateway (SocketAddress *address) |
Get the local gateway. | |
virtual char * | get_interface_name (char *interface_name) |
Get the network interface name. | |
virtual nsapi_error_t | set_network (const SocketAddress &ip_address, const SocketAddress &netmask, const SocketAddress &gateway) |
Configure this network interface to use a static IP address. | |
virtual nsapi_error_t | set_dhcp (bool dhcp) |
Enable or disable DHCP on connecting the network. | |
virtual nsapi_error_t | gethostbyname (const char *host, SocketAddress *address, nsapi_version_t version=NSAPI_UNSPEC, const char *interface_name=NULL) |
Translate a hostname to an IP address with specific version using network interface name. | |
virtual nsapi_value_or_error_t | gethostbyname_async (const char *host, hostbyname_cb_t callback, nsapi_version_t version=NSAPI_UNSPEC, const char *interface_name=NULL) |
Translate a hostname to an IP address (asynchronous) using network interface name. | |
virtual nsapi_error_t | gethostbyname_async_cancel (int id) |
Cancel asynchronous hostname translation. | |
virtual nsapi_error_t | add_dns_server (const SocketAddress &address, const char *interface_name) |
Add a domain name server to list of servers to query. | |
void | add_event_listener (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb) |
Add event listener for interface. | |
void | remove_event_listener (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb) |
Remove event listener from interface. | |
virtual EthInterface * | ethInterface () |
Return pointer to an EthInterface. | |
virtual WiFiInterface * | wifiInterface () |
Return pointer to a WiFiInterface. | |
virtual MeshInterface * | meshInterface () |
Return pointer to a MeshInterface. | |
virtual MeshInterface * | meshInterface () |
virtual EMACInterface * | emacInterface () |
Return pointer to an EMACInterface. | |
virtual CellularInterface * | cellularInterface () |
Return pointer to a CellularInterface. | |
virtual void | set_default_parameters () |
Set default parameters on an interface. | |
Static Public Member Functions | |
static NetworkInterface * | get_default_instance () |
Return the default network interface. | |
static MeshInterface * | get_default_instance () |
Get the default Mesh interface. | |
Static Protected Member Functions | |
static NetworkInterface * | get_target_default_instance () |
Get the target's default network instance. | |
static MeshInterface * | get_target_default_instance () |
Get the target's default Mesh interface. | |
Friends | |
class | InternetSocket |
class | UDPSocket |
class | TCPSocket |
class | TCPServer |
class | SocketAddress |
Detailed Description
Wi-SUN mesh network interface class.
Configure Nanostack to use Wi-SUN protocol.
Definition at line 26 of file WisunInterface.h.
Member Typedef Documentation
typedef mbed::Callback<void (nsapi_error_t result, SocketAddress *address) hostbyname_cb_t) [inherited] |
Hostname translation callback (for use with gethostbyname_async()).
Callback will be called after DNS resolution completes or a failure occurs.
- Note:
- Callback should not take more than 10ms to execute, otherwise it might prevent underlying thread processing. A portable user of the callback should not make calls to network operations due to stack size limitations. The callback should not perform expensive operations such as socket recv/send calls or blocking operations.
- Parameters:
-
result NSAPI_ERROR_OK on success, negative error code on failure. address On success, destination for the host SocketAddress.
Reimplemented from DNS.
Definition at line 253 of file NetworkInterface.h.
Constructor & Destructor Documentation
WisunInterface | ( | ) |
Create an uninitialized WisunInterface.
Must initialize to initialize the mesh on a phy.
Definition at line 33 of file WisunInterface.h.
WisunInterface | ( | NanostackRfPhy * | phy ) |
Create an initialized WisunInterface.
Definition at line 38 of file WisunInterface.h.
Member Function Documentation
nsapi_error_t add_dns_server | ( | const SocketAddress & | address, |
const char * | interface_name | ||
) | [virtual, inherited] |
Add a domain name server to list of servers to query.
- Parameters:
-
address Address for the dns host.
- Returns:
- NSAPI_ERROR_OK on success, negative error code on failure.
Implements DNS.
Definition at line 109 of file NetworkInterface.cpp.
void add_event_listener | ( | mbed::Callback< void(nsapi_event_t, intptr_t)> | status_cb ) | [inherited] |
Add event listener for interface.
This API allows multiple callback to be registered for a single interface. When first called, internal list of event handlers are created and registered to interface through attach() API.
Application may only use attach() or add_event_listener() interface. Mixing usage of both leads to undefined behavior.
- Parameters:
-
status_cb The callback for status changes.
Definition at line 144 of file NetworkInterface.cpp.
void attach | ( | mbed::Callback< void(nsapi_event_t, intptr_t)> | status_cb ) | [virtual, inherited] |
Register callback for status reporting.
The specified status callback function will be called on status changes on the network. The parameters on the callback are the event type and event-type dependent reason parameter.
- Parameters:
-
status_cb The callback for status changes
Definition at line 238 of file MeshInterfaceNanostack.cpp.
virtual CellularInterface* cellularInterface | ( | ) | [virtual, inherited] |
Return pointer to a CellularInterface.
- Returns:
- Pointer to requested interface type or NULL if this class doesn't implement the interface.
Reimplemented in CellularInterface.
Definition at line 387 of file NetworkInterface.h.
int connect | ( | ) | [virtual, inherited] |
Start the interface.
- Returns:
- 0 on success, negative error code on failure
Definition at line 109 of file MeshInterfaceNanostack.cpp.
int disconnect | ( | void | ) | [virtual, inherited] |
Stop the interface.
- Returns:
- 0 on success, negative error code on failure
Definition at line 119 of file MeshInterfaceNanostack.cpp.
virtual EMACInterface* emacInterface | ( | ) | [virtual, inherited] |
Return pointer to an EMACInterface.
- Returns:
- Pointer to requested interface type or NULL if this class doesn't implement the interface.
Reimplemented in EMACInterface.
Definition at line 379 of file NetworkInterface.h.
virtual EthInterface* ethInterface | ( | ) | [virtual, inherited] |
Return pointer to an EthInterface.
- Returns:
- Pointer to requested interface type or NULL if this class doesn't implement the interface.
Reimplemented in EthInterface.
Definition at line 355 of file NetworkInterface.h.
nsapi_connection_status_t get_connection_status | ( | ) | const [virtual, inherited] |
Get the connection status.
- Returns:
- The connection status according to ConnectionStatusType
Definition at line 229 of file MeshInterfaceNanostack.cpp.
MBED_WEAK NetworkInterface * get_default_instance | ( | ) | [static, inherited] |
Return the default network interface.
Returns the default network interface, as determined by JSON option target.network-default-interface-type or other overrides.
The type of the interface returned can be tested by calling ethInterface(), wifiInterface(), meshInterface(), cellularInterface(), emacInterface() and checking for NULL pointers.
The default behavior is to return the default interface for the interface type specified by target.network-default-interface-type. Targets should set this in their targets.json to guide default selection, and applications may override.
The interface returned should be already configured for use such that its connect() method works with no parameters. For connection types needing configuration, settings should normally be obtained from JSON - the settings for the core types are under the "nsapi" JSON config tree.
The list of possible settings for default interface type is open-ended, as is the number of possible providers. Core providers are:
* ETHERNET: EthernetInterface, using default EMAC and OnboardNetworkStack * MESH: ThreadInterface or LoWPANNDInterface, using default NanostackRfPhy * CELLULAR: OnboardModemInterface * WIFI: None - always provided by a specific class
Specific drivers may be activated by other settings of the default-network-interface-type configuration. This will depend on the target and the driver. For example a board may have its default setting as "AUTO" which causes it to autodetect an Ethernet cable. This should be described in the target's documentation.
An application can override all target settings by implementing NetworkInterface::get_default_instance() themselves - the default definition is weak, and calls get_target_default_instance().
Reimplemented in CellularContext, CellularInterface, EthInterface, MeshInterface, and WiFiInterface.
Definition at line 60 of file NetworkInterfaceDefaults.cpp.
MBED_WEAK MeshInterface * get_default_instance | ( | ) | [static, inherited] |
Get the default Mesh interface.
This is provided as a weak method so applications can override. Default behavior is to get the target's default interface, if any.
- Returns:
- pointer to interface, if any.
Reimplemented from NetworkInterface.
Definition at line 38 of file NetworkInterfaceDefaults.cpp.
nsapi_error_t get_gateway | ( | SocketAddress * | address ) | [virtual, inherited] |
Get the local gateway.
- Parameters:
-
address SocketAddress representation of gateway address
- Return values:
-
NSAPI_ERROR_OK on success NSAPI_ERROR_UNSUPPORTED if this feature is not supported NSAPI_ERROR_PARAMETER if the provided pointer is invalid NSAPI_ERROR_NO_ADDRESS if the address cannot be obtained from stack
Reimplemented in ESP8266Interface, CellularContext, CellularInterface, EMACInterface, and PPPInterface.
Definition at line 60 of file NetworkInterface.cpp.
int8_t get_interface_id | ( | ) | const [inherited] |
Get the interface ID.
- Returns:
- Interface identifier
Definition at line 155 of file MeshInterfaceNanostack.h.
char * get_interface_name | ( | char * | interface_name ) | [virtual, inherited] |
Get the network interface name.
- Returns:
- Null-terminated representation of the network interface name or null if interface not exists
Reimplemented in ESP8266Interface, EMACInterface, L3IPInterface, and PPPInterface.
Definition at line 70 of file NetworkInterface.cpp.
nsapi_error_t get_ip_address | ( | SocketAddress * | address ) | [virtual, inherited] |
Get the local IP address.
- Parameters:
-
address SocketAddress representation of the local IP address
- Return values:
-
NSAPI_ERROR_OK on success NSAPI_ERROR_UNSUPPORTED if this feature is not supported NSAPI_ERROR_PARAMETER if the provided pointer is invalid NSAPI_ERROR_NO_ADDRESS if the address cannot be obtained from stack
Definition at line 203 of file MeshInterfaceNanostack.cpp.
nsapi_error_t get_ipv6_link_local_address | ( | SocketAddress * | address ) | [virtual, inherited] |
Get the IPv6 link local address.
- Parameters:
-
address SocketAddress representation of the link local IPv6 address
- Return values:
-
NSAPI_ERROR_OK on success NSAPI_ERROR_UNSUPPORTED if this feature is not supported NSAPI_ERROR_PARAMETER if the provided pointer is invalid
Reimplemented in EMACInterface.
Definition at line 45 of file NetworkInterface.cpp.
const char * get_mac_address | ( | ) | [virtual, inherited] |
Get the internally stored MAC address /return MAC address of the interface.
Definition at line 221 of file MeshInterfaceNanostack.cpp.
nsapi_error_t get_netmask | ( | SocketAddress * | address ) | [virtual, inherited] |
Get the local network mask.
- Parameters:
-
address SocketAddress representation of netmask
- Return values:
-
NSAPI_ERROR_OK on success NSAPI_ERROR_UNSUPPORTED if this feature is not supported NSAPI_ERROR_PARAMETER if the provided pointer is invalid NSAPI_ERROR_NO_ADDRESS if the address cannot be obtained from stack
Reimplemented in ESP8266Interface, CellularContext, CellularInterface, EMACInterface, and PPPInterface.
Definition at line 50 of file NetworkInterface.cpp.
MBED_WEAK NetworkInterface * get_target_default_instance | ( | ) | [static, protected, inherited] |
Get the target's default network instance.
This method can be overridden by the target. Default implementations are provided weakly by various subsystems as described in NetworkInterface::get_default_instance(), so targets should not need to override in simple cases.
If a target has more elaborate interface selection, it can completely override this behavior by implementing NetworkInterface::get_target_default_instance() themselves, either unconditionally, or for a specific network-default-interface-type setting
For example, a device with both Ethernet and Wi-fi could be set up its target so that: * DEVICE_EMAC is set, and it provides EMAC::get_default_instance(), which means EthernetInterface provides EthInterface::get_target_instance() based on that EMAC. * It provides WifiInterface::get_target_default_instance(). * The core will route NetworkInterface::get_default_instance() to either of those if network-default-interface-type is set to ETHERNET or WIFI. * The board overrides NetworkInterface::get_target_default_instance() if network-default-interface-type is set to AUTO. This returns either EthInterface::get_default_instance() or WiFIInterface::get_default_instance() depending on a cable detection.
performs the search described by get_default_instance.
Reimplemented in CellularInterface, EthInterface, MeshInterface, and WiFiInterface.
Definition at line 121 of file NetworkInterfaceDefaults.cpp.
MBED_WEAK MeshInterface * get_target_default_instance | ( | ) | [static, protected, inherited] |
Get the target's default Mesh interface.
This is provided as a weak method so targets can override. The default implementation will invoke LoWPANNDInterface or ThreadInterface with the default NanostackRfPhy.
- Returns:
- pointer to interface, if any.
Reimplemented from NetworkInterface.
Definition at line 180 of file LoWPANNDInterface.cpp.
nsapi_error_t gethostbyname | ( | const char * | host, |
SocketAddress * | address, | ||
nsapi_version_t | version = NSAPI_UNSPEC , |
||
const char * | interface_name = NULL |
||
) | [virtual, inherited] |
Translate a hostname to an IP address with specific version using network interface name.
The hostname may be either a domain name or an IP address. If the hostname is an IP address, no network transactions will be performed.
If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.
- Parameters:
-
host Hostname to resolve. address Pointer to a SocketAddress to store the result. version IP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC). interface_name Network interface name
- Return values:
-
NSAPI_ERROR_OK on success int Negative error code on failure. See NetworkStack::gethostbyname
Implements DNS.
Definition at line 94 of file NetworkInterface.cpp.
nsapi_value_or_error_t gethostbyname_async | ( | const char * | host, |
hostbyname_cb_t | callback, | ||
nsapi_version_t | version = NSAPI_UNSPEC , |
||
const char * | interface_name = NULL |
||
) | [virtual, inherited] |
Translate a hostname to an IP address (asynchronous) using network interface name.
The hostname may be either a domain name or a dotted IP address. If the hostname is an IP address, no network transactions will be performed.
If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.
Call is non-blocking. Result of the DNS operation is returned by the callback. If this function returns failure, callback will not be called. In case result is success (IP address was found from DNS cache), callback will be called before function returns.
- Parameters:
-
host Hostname to resolve. callback Callback that is called for result. version IP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC). interface_name Network interface name
- Returns:
- 0 on immediate success, negative error code on immediate failure or a positive unique id that represents the hostname translation operation and can be passed to cancel.
Implements DNS.
Definition at line 99 of file NetworkInterface.cpp.
nsapi_error_t gethostbyname_async_cancel | ( | int | id ) | [virtual, inherited] |
Cancel asynchronous hostname translation.
When translation is cancelled, callback will not be called.
- Parameters:
-
id Unique id of the hostname translation operation (returned by gethostbyname_async)
- Returns:
- NSAPI_ERROR_OK on success, negative error code on failure.
Implements DNS.
Definition at line 104 of file NetworkInterface.cpp.
bool getRouterIpAddress | ( | char * | address, |
int8_t | len | ||
) |
nsapi_error_t initialize | ( | NanostackRfPhy * | phy ) | [inherited] |
Attach phy and initialize the mesh.
Initializes a mesh interface on the given phy. Not needed if the phy is passed to the mesh's constructor.
- Returns:
- 0 on success, negative on failure
Definition at line 127 of file MeshInterfaceNanostack.cpp.
virtual MeshInterface* meshInterface | ( | ) | [virtual, inherited] |
Return pointer to a MeshInterface.
- Returns:
- Pointer to requested interface type or NULL if this class doesn't implement the interface.
Reimplemented in MeshInterface.
Definition at line 371 of file NetworkInterface.h.
virtual MeshInterface* meshInterface | ( | ) | [virtual, inherited] |
Return pointer to a MeshInterface.
- Returns:
- Pointer to requested interface type or NULL if this class doesn't implement the interface.
Reimplemented from NetworkInterface.
Definition at line 33 of file MeshInterface.h.
void remove_event_listener | ( | mbed::Callback< void(nsapi_event_t, intptr_t)> | status_cb ) | [inherited] |
Remove event listener from interface.
Remove previously added callback from the handler list.
- Parameters:
-
status_cb The callback to unregister.
Definition at line 154 of file NetworkInterface.cpp.
mesh_error_t remove_own_certificates | ( | void | ) |
Remove own certificates from the Wi-SUN network.
Function must be called before connecting the device i.e before call to connect() method.
- Returns:
- MESH_ERROR_NONE on success.
- MESH_ERROR_STATE if method is called after calling connect().
Definition at line 216 of file WisunInterface.cpp.
mesh_error_t remove_trusted_certificates | ( | void | ) |
Remove trusted certificates from the Wi-SUN network.
Function must be called before connecting the device i.e before call to connect() method.
- Returns:
- MESH_ERROR_NONE on success.
- MESH_ERROR_STATE if method is called after calling connect().
Definition at line 242 of file WisunInterface.cpp.
void set_as_default | ( | ) | [virtual, inherited] |
Set network interface as default one.
Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.
Definition at line 25 of file NetworkInterface.cpp.
nsapi_error_t set_blocking | ( | bool | blocking ) | [virtual, inherited] |
Set blocking status of connect() which by default should be blocking.
- Parameters:
-
blocking true if connect is blocking
- Returns:
- 0 on success, negative error code on failure
Definition at line 247 of file MeshInterfaceNanostack.cpp.
void set_default_parameters | ( | ) | [virtual, inherited] |
Set default parameters on an interface.
A network interface instantiated directly or using calls such as WiFiInterface::get_default_instance() is initially unconfigured. This call can be used to set the default parameters that would have been set if the interface had been requested using NetworkInterface::get_default_instance() (see nsapi JSON configuration).
Reimplemented in CellularInterface, and WiFiInterface.
Definition at line 69 of file NetworkInterfaceDefaults.cpp.
nsapi_error_t set_dhcp | ( | bool | dhcp ) | [virtual, inherited] |
Enable or disable DHCP on connecting the network.
Enabled by default unless a static IP address has been assigned. Requires that the network is disconnected.
- Parameters:
-
dhcp True to enable DHCP.
- Return values:
-
NSAPI_ERROR_OK on success. NSAPI_ERROR_UNSUPPORTED if operation is not supported.
Reimplemented in EMACInterface, and L3IPInterface.
Definition at line 85 of file NetworkInterface.cpp.
nsapi_error_t set_file_system_root_path | ( | const char * | root_path ) | [virtual, inherited] |
Set file system root path.
Set file system root path that stack will use to write and read its data. Setting root_path to NULL will disable file system usage.
- Parameters:
-
root_path Address to NUL-terminated root-path string or NULL to disable file system usage.
- Returns:
- MESH_ERROR_NONE on success, MESH_ERROR_MEMORY in case of memory failure, MESH_ERROR_UNKNOWN in case of other error.
Definition at line 253 of file MeshInterfaceNanostack.cpp.
nsapi_error_t set_network | ( | const SocketAddress & | ip_address, |
const SocketAddress & | netmask, | ||
const SocketAddress & | gateway | ||
) | [virtual, inherited] |
Configure this network interface to use a static IP address.
Implicitly disables DHCP, which can be enabled in set_dhcp. Requires that the network is disconnected.
- Parameters:
-
ip_address SocketAddress object containing the local IP address netmask SocketAddress object containing the local network mask gateway SocketAddress object containing the local gateway
- Return values:
-
NSAPI_ERROR_OK on success NSAPI_ERROR_UNSUPPORTED if this function is unsupported
Reimplemented in EMACInterface.
Definition at line 80 of file NetworkInterface.cpp.
mesh_error_t set_network_name | ( | char * | network_name ) |
Set Wi-SUN network name.
Function stores new network name to mbed-mesh-api and uses it when connect() is called next time. If device is already connected to the Wi-SUN network then device will restart network discovery after changing the network name.
Function overwrites network name defined by Mbed OS configuration.
- Parameters:
-
network_name Network name as NUL terminated string. Can't exceed 32 characters and can't be NULL.
- Returns:
- MESH_ERROR_NONE on success.
- MESH_ERROR_UNKNOWN in case of failure.
Definition at line 179 of file WisunInterface.cpp.
mesh_error_t set_network_regulatory_domain | ( | uint8_t | regulatory_domain = 0xff , |
uint8_t | operating_class = 0xff , |
||
uint8_t | operating_mode = 0xff |
||
) |
Set Wi-SUN network regulatory domain, operating class and operating mode.
Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time. If device is already connected to the Wi-SUN network then device will restart network discovery after changing the regulatory_domain, operating_class or operating_mode.
Function overwrites parameters defined by Mbed OS configuration.
- Parameters:
-
regulatory_domain Values defined in Wi-SUN PHY-specification. Use 0xff to use leave parameter unchanged. operating_class Values defined in Wi-SUN PHY-specification. Use 0xff to use leave parameter unchanged. operating_mode Values defined in Wi-SUN PHY-specification. Use 0xff to use leave parameter unchanged.
- Returns:
- MESH_ERROR_NONE on success.
- MESH_ERROR_UNKNOWN in case of failure.
Definition at line 191 of file WisunInterface.cpp.
mesh_error_t set_own_certificate | ( | uint8_t * | cert, |
uint16_t | cert_len, | ||
uint8_t * | cert_key = NULL , |
||
uint16_t | cert_key_len = 0 |
||
) |
Set own certificate and private key reference to the Wi-SUN network.
Function can be called several times if intermediate certificates are used. Then each call to the function adds a certificate reference to own certificate chain. Certificates are in bottom up order i.e. the top certificate is given last.
Function must be called before connecting the device i.e before call to connect() method. Function will not copy certificate or key, therefore addresses must remain valid.
- Parameters:
-
cert Certificate address. cert_len Certificate length in bytes. cert_key Certificate key address. cert_key_len Certificate key length in bytes.
- Returns:
- MESH_ERROR_NONE on success.
- MESH_ERROR_STATE if method is called after calling connect().
- MESH_ERROR_MEMORY in case of memory allocation failure.
Definition at line 203 of file WisunInterface.cpp.
mesh_error_t set_trusted_certificate | ( | uint8_t * | cert, |
uint16_t | cert_len | ||
) |
Set trusted certificate reference to the Wi-SUN network.
Function can be called several times. Certificates are in bottom up order i.e. the top certificate is given last.
Function must be called before connecting the device i.e before call to connect() method. Function will not copy certificate, therefore addresses must remain valid.
- Parameters:
-
cert Certificate address. cert_len Certificate length in bytes.
- Returns:
- MESH_ERROR_NONE on success.
- MESH_ERROR_STATE if method is called after calling connect().
- MESH_ERROR_MEMORY in case of memory allocation failure.
Definition at line 229 of file WisunInterface.cpp.
virtual WiFiInterface* wifiInterface | ( | ) | [virtual, inherited] |
Return pointer to a WiFiInterface.
- Returns:
- Pointer to requested interface type or NULL if this class doesn't implement the interface.
Reimplemented in WiFiInterface.
Definition at line 363 of file NetworkInterface.h.
Generated on Tue Jul 12 2022 13:55:38 by
