cliff Hong
ThingPlug Test
Dependents: WizFi310_ThingPlug_Test WizFi310_ThingPlug_Test_P
Fork of
WizFi310Interface
by 
WIZnet
WizFi310Interface Class Reference
WizFi310Interface class Implementation of the NetworkStack for the WizFi310. More...
#include <WizFi310Interface.h>
Public Member Functions | |
| virtual int | disconnect () |
| Stop the interface. | |
| virtual const char * | get_ip_address () |
| Get the internally stored IP address. | |
| virtual const char * | get_mac_address () |
| Get the internally stored MAC address. | |
Protected Member Functions | |
| virtual int | socket_open (void **handle, nsapi_protocol_t proto) |
| Open a socket. | |
| virtual int | socket_close (void *handle) |
| Close the socket. | |
| virtual int | socket_bind (void *handle, const SocketAddress &address) |
| Bind a server socket to a specific port. | |
| virtual int | socket_listen (void *handle, int backlog) |
| Start listening for incoming connections. | |
| virtual int | socket_connect (void *handle, const SocketAddress &address) |
| Connects this TCP socket to the server. | |
| virtual int | socket_accept (void **handle, void *server) |
| Accept a new connection. | |
| virtual int | socket_send (void *handle, const void *data, unsigned size) |
| Send data to the remote host. | |
| virtual int | socket_recv (void *handle, void *data, unsigned size) |
| Receive data from the remote host. | |
| virtual int | socket_sendto (void *handle, const SocketAddress &address, const void *data, unsigned size) |
| Send a packet to a remote endpoint. | |
| virtual int | socket_recvfrom (void *handle, SocketAddress *address, void *buffer, unsigned size) |
| Receive a packet from a remote endpoint. | |
| virtual void | socket_attach (void *handle, void(*callback)(void *), void *data) |
| Register a callback on state change of the socket. | |
Detailed Description
WizFi310Interface class Implementation of the NetworkStack for the WizFi310.
Definition at line 30 of file WizFi310Interface.h.
Member Function Documentation
| int disconnect | ( | void | ) | [virtual] |
Stop the interface.
- Returns:
- 0 on success, negative on failure
Definition at line 58 of file WizFi310Interface.cpp.
| const char * get_ip_address | ( | ) | [virtual] |
Get the internally stored IP address.
- Returns:
- IP address of the interface or null if not yet connected
Definition at line 65 of file WizFi310Interface.cpp.
| const char * get_mac_address | ( | ) | [virtual] |
Get the internally stored MAC address.
- Returns:
- MAC address of the interface
Definition at line 70 of file WizFi310Interface.cpp.
| int socket_accept | ( | void ** | handle, |
| void * | server | ||
| ) | [protected, virtual] |
Accept a new connection.
- Parameters:
-
handle Handle in which to store new socket server Socket handle to server to accept from
- Returns:
- 0 on success, negative on failure
- Note:
- This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT
Definition at line 246 of file WizFi310Interface.cpp.
| void socket_attach | ( | void * | handle, |
| void(*)(void *) | callback, | ||
| void * | data | ||
| ) | [protected, virtual] |
Register a callback on state change of the socket.
- Parameters:
-
handle Socket handle callback Function to call on state change data Argument to pass to callback
- Note:
- Callback may be called in an interrupt context.
Definition at line 293 of file WizFi310Interface.cpp.
| int socket_bind | ( | void * | handle, |
| const SocketAddress & | address | ||
| ) | [protected, virtual] |
Bind a server socket to a specific port.
- Parameters:
-
handle Socket handle address Local address to listen for incoming connections on
- Returns:
- 0 on success, negative on failure.
Definition at line 213 of file WizFi310Interface.cpp.
| int socket_close | ( | void * | handle ) | [protected, virtual] |
Close the socket.
- Parameters:
-
handle Socket handle
- Returns:
- 0 on success, negative on failure
- Note:
- On failure, any memory associated with the socket must still be cleaned up
Definition at line 195 of file WizFi310Interface.cpp.
| int socket_connect | ( | void * | handle, |
| const SocketAddress & | address | ||
| ) | [protected, virtual] |
Connects this TCP socket to the server.
- Parameters:
-
handle Socket handle address SocketAddress to connect to
- Returns:
- 0 on success, negative on failure
Definition at line 223 of file WizFi310Interface.cpp.
| int socket_listen | ( | void * | handle, |
| int | backlog | ||
| ) | [protected, virtual] |
Start listening for incoming connections.
- Parameters:
-
handle Socket handle backlog Number of pending connections that can be queued up at any one time [Default: 1]
- Returns:
- 0 on success, negative on failure
Definition at line 218 of file WizFi310Interface.cpp.
| int socket_open | ( | void ** | handle, |
| nsapi_protocol_t | proto | ||
| ) | [protected, virtual] |
Open a socket.
- Parameters:
-
handle Handle in which to store new socket proto Type of socket to open, NSAPI_TCP or NSAPI_UDP
- Returns:
- 0 on success, negative on failure
Definition at line 163 of file WizFi310Interface.cpp.
| int socket_recv | ( | void * | handle, |
| void * | data, | ||
| unsigned | size | ||
| ) | [protected, virtual] |
Receive data from the remote host.
- Parameters:
-
handle Socket handle data The buffer in which to store the data received from the host size The maximum length of the buffer
- Returns:
- Number of received bytes on success, negative on failure
- Note:
- This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT
Definition at line 262 of file WizFi310Interface.cpp.
| int socket_recvfrom | ( | void * | handle, |
| SocketAddress * | address, | ||
| void * | buffer, | ||
| unsigned | size | ||
| ) | [protected, virtual] |
Receive a packet from a remote endpoint.
- Parameters:
-
handle Socket handle address Destination for the remote SocketAddress or null buffer The buffer for storing the incoming packet data If a packet is too long to fit in the supplied buffer, excess bytes are discarded size The length of the buffer
- Returns:
- The number of received bytes on success, negative on failure
- Note:
- This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT
Definition at line 287 of file WizFi310Interface.cpp.
| int socket_send | ( | void * | handle, |
| const void * | data, | ||
| unsigned | size | ||
| ) | [protected, virtual] |
Send data to the remote host.
- Parameters:
-
handle Socket handle data The buffer to send to the host size The length of the buffer to send
- Returns:
- Number of written bytes on success, negative on failure
- Note:
- This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT
Definition at line 251 of file WizFi310Interface.cpp.
| int socket_sendto | ( | void * | handle, |
| const SocketAddress & | address, | ||
| const void * | data, | ||
| unsigned | size | ||
| ) | [protected, virtual] |
Send a packet to a remote endpoint.
- Parameters:
-
handle Socket handle address The remote SocketAddress data The packet to be sent size The length of the packet to be sent
- Returns:
- The number of written bytes on success, negative on failure
- Note:
- This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT
Definition at line 274 of file WizFi310Interface.cpp.
Generated on Sat Jul 16 2022 03:26:38 by
1.7.2