Klika Tech
Example of AWS IoT connection and Web Dashboard thru STM32 Nucleo evaluation board and mbed OS.
Dependencies: X_NUCLEO_IKS01A1 mbed FP MQTTPacket DnsQuery ATParser
Socket Class Reference
Abstract socket class. More...
#include <Socket.h>
Inherited by TCPServer, TCPSocket, and UDPSocket.
Public Member Functions | |
| virtual | ~Socket () |
| Destroy a socket. | |
| virtual int | open (NetworkStack *iface)=0 |
| Opens a socket. | |
| int | close () |
| Close the socket. | |
| int | bind (uint16_t port) |
| Bind a specific address to a socket. | |
| int | bind (const char *address, uint16_t port) |
| Bind a specific address to a socket. | |
| int | bind (const SocketAddress &address) |
| Bind a specific address to a socket. | |
| void | set_blocking (bool blocking) |
| Set blocking or non-blocking mode of the socket. | |
| void | set_timeout (int timeout) |
| Set timeout on blocking socket operations. | |
| void | attach (FunctionPointer callback) |
| Register a callback on state change of the socket. | |
| template<typename T , typename M > | |
| void | attach (T *tptr, M mptr) |
| Register a callback on state change of the socket. | |
Detailed Description
Abstract socket class.
Definition at line 25 of file Socket.h.
Constructor & Destructor Documentation
| ~Socket | ( | ) | [virtual] |
Destroy a socket.
Closes socket if the socket is still open
Definition at line 26 of file Socket.cpp.
Member Function Documentation
| void attach | ( | FunctionPointer | callback ) |
Register a callback on state change of the socket.
The specified callback will be called on state changes such as when the socket can recv/send/accept successfully and on when an error occurs. The callback may also be called spuriously without reason.
The callback may be called in an interrupt context and should not perform expensive operations such as recv/send calls.
- Parameters:
-
callback Function to call on state change
Definition at line 124 of file Socket.cpp.
| void attach | ( | T * | tptr, |
| M | mptr | ||
| ) |
Register a callback on state change of the socket.
The specified callback will be called on state changes such as when the socket can recv/send/accept successfully and on when an error occurs. The callback may also be called spuriously without reason.
The callback may be called in an interrupt context and should not perform expensive operations such as recv/send calls.
- Parameters:
-
tptr Pointer to object to call method on mptr Method to call on state change
| int bind | ( | uint16_t | port ) |
Bind a specific address to a socket.
Binding a socket specifies the address and port on which to recieve data.
- Parameters:
-
port Local port to bind
- Returns:
- 0 on success, negative error code on failure.
Definition at line 62 of file Socket.cpp.
| int bind | ( | const SocketAddress & | address ) |
Bind a specific address to a socket.
Binding a socket specifies the address and port on which to recieve data. If the IP address is zeroed, only the port is bound.
- Parameters:
-
address Local address to bind
- Returns:
- 0 on success, negative error code on failure.
Definition at line 74 of file Socket.cpp.
| int bind | ( | const char * | address, |
| uint16_t | port | ||
| ) |
Bind a specific address to a socket.
Binding a socket specifies the address and port on which to recieve data. If the IP address is zeroed, only the port is bound.
- Parameters:
-
address Null-terminated local address to bind port Local port to bind
- Returns:
- 0 on success, negative error code on failure.
Definition at line 68 of file Socket.cpp.
| int close | ( | ) |
Close the socket.
Closes any open connection and deallocates any memory associated with the socket. Called from destructor if socket is not closed.
- Returns:
- 0 on success, negative error code on failure
Definition at line 49 of file Socket.cpp.
| virtual int open | ( | NetworkStack * | iface ) | [pure virtual] |
| void set_blocking | ( | bool | blocking ) |
Set blocking or non-blocking mode of the socket.
Initially all sockets are in blocking mode. In non-blocking mode blocking operations such as send/recv/accept return NSAPI_ERROR_WOULD_BLOCK if they can not continue.
set_blocking(false) is equivalent to set_timeout(-1) set_blocking(true) is equivalent to set_timeout(0)
- Parameters:
-
blocking true for blocking mode, false for non-blocking mode.
Definition at line 83 of file Socket.cpp.
| void set_timeout | ( | int | timeout ) |
Set timeout on blocking socket operations.
Initially all sockets have unbounded timeouts. NSAPI_ERROR_WOULD_BLOCK is returned if a blocking operation takes longer than the specified timeout. A timeout of -1 removes the timeout from the socket.
set_timeout(-1) is equivalent to set_blocking(false) set_timeout(0) is equivalent to set_blocking(true)
- Parameters:
-
timeout Timeout in milliseconds
Definition at line 88 of file Socket.cpp.
Generated on Wed Jul 13 2022 20:28:49 by
1.7.2