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.
Dependencies: mbed Socket lwip-eth lwip-sys lwip
Fork of
6_songs-from-the-cloud
by 
MakingMusicWorkshop
M2MConnectionHandler Class Reference
#include <m2mconnectionhandler.h>
Public Types | |
| enum | ConnectionError |
This enum defines an error that can come from socket read and write operation. More... | |
Public Member Functions | |
| M2MConnectionHandler (M2MConnectionObserver &observer, M2MConnectionSecurity *sec, M2MInterface::BindingMode mode, M2MInterface::NetworkStack stack) | |
| Constructor. | |
| ~M2MConnectionHandler () | |
| Destructor. | |
| bool | bind_connection (const uint16_t listen_port) |
| This binds the socket connection. | |
| bool | resolve_server_address (const String &server_address, const uint16_t server_port, M2MConnectionObserver::ServerType server_type, const M2MSecurity *security) |
| This resolves the server address. | |
| bool | send_data (uint8_t *data_ptr, uint16_t data_len, sn_nsdl_addr_s *address_ptr) |
| Sends data to the connected server. | |
| bool | start_listening_for_data () |
| Listens to the incoming data from a remote server. | |
| void | stop_listening () |
| Stops listening to the incoming data. | |
| int | send_to_socket (const unsigned char *buf, size_t len) |
| sendToSocket Sends directly to socket. | |
| int | receive_from_socket (unsigned char *buf, size_t len) |
| receiveFromSocket Receives directly from a socket. | |
| void | close_connection () |
| Closes the open connection. | |
| void | handle_connection_error (int error) |
| Error handling for DTLS connectivity. | |
Detailed Description
This class handles the socket connection for the LWM2M Client.
Definition at line 32 of file m2mconnectionhandler.h.
Member Enumeration Documentation
| enum ConnectionError |
This enum defines an error that can come from socket read and write operation.
Definition at line 40 of file m2mconnectionhandler.h.
Constructor & Destructor Documentation
| M2MConnectionHandler | ( | M2MConnectionObserver & | observer, |
| M2MConnectionSecurity * | sec, | ||
| M2MInterface::BindingMode | mode, | ||
| M2MInterface::NetworkStack | stack | ||
| ) |
Constructor.
Definition at line 21 of file m2mconnectionhandler.cpp.
| ~M2MConnectionHandler | ( | ) |
Destructor.
Definition at line 30 of file m2mconnectionhandler.cpp.
Member Function Documentation
| bool bind_connection | ( | const uint16_t | listen_port ) |
This binds the socket connection.
- Parameters:
-
listen_port Port to be listened to for an incoming connection.
- Returns:
- True if successful, else false.
Definition at line 35 of file m2mconnectionhandler.cpp.
| void close_connection | ( | ) |
Closes the open connection.
| void handle_connection_error | ( | int | error ) |
Error handling for DTLS connectivity.
- Parameters:
-
error,Error code from TLS library
Definition at line 77 of file m2mconnectionhandler.cpp.
| int receive_from_socket | ( | unsigned char * | buf, |
| size_t | len | ||
| ) |
receiveFromSocket Receives directly from a socket.
This is used by the security classes to receive raw data to be decrypted.
- Parameters:
-
buf Buffer to send. len Length of a buffer.
- Returns:
- Number of bytes read or -1 if failed.
Definition at line 65 of file m2mconnectionhandler.cpp.
| bool resolve_server_address | ( | const String & | server_address, |
| const uint16_t | server_port, | ||
| M2MConnectionObserver::ServerType | server_type, | ||
| const M2MSecurity * | security | ||
| ) |
This resolves the server address.
Output is returned through a callback.
- Parameters:
-
String Server address. uint16_t Server port. ServerType,Server Type to be resolved. security,M2MSecurity object that determines what type of secure connection will be used by the socket.
- Returns:
- True if address is valid, else false.
Definition at line 41 of file m2mconnectionhandler.cpp.
| bool send_data | ( | uint8_t * | data_ptr, |
| uint16_t | data_len, | ||
| sn_nsdl_addr_s * | address_ptr | ||
| ) |
Sends data to the connected server.
- Parameters:
-
data_ptr,Data to be sent. data_len,Length of data to be sent. address_ptr,Address structure where data has to be sent.
- Returns:
- True if data is sent successfully, else false.
Definition at line 70 of file m2mconnectionhandler.cpp.
| int send_to_socket | ( | const unsigned char * | buf, |
| size_t | len | ||
| ) |
sendToSocket Sends directly to socket.
This is used by security classes to send the data after it has been encrypted.
- Parameters:
-
buf Buffer to send. len Length of a buffer.
- Returns:
- Number of bytes sent or -1 if failed.
Definition at line 60 of file m2mconnectionhandler.cpp.
| bool start_listening_for_data | ( | ) |
Listens to the incoming data from a remote server.
- Returns:
- True if successful, else false.
Definition at line 50 of file m2mconnectionhandler.cpp.
| void stop_listening | ( | ) |
Stops listening to the incoming data.
Definition at line 55 of file m2mconnectionhandler.cpp.
Generated on Tue Jul 12 2022 12:47:53 by
1.7.2