Klika Tech / Mbed 2 deprecated Nucleo-AWS-IoT-mbed

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

Embed: (wiki syntax)

« Back to documentation index

TCPServer Class Reference
Public Member Functions

TCPServer Class Reference

TCP socket server. More...

#include <TCPServer.h>

Inherits Socket.

Public Member Functions

 TCPServer ()
 Create an uninitialized socket.
 TCPServer (NetworkStack *iface)
 Create a socket on a network stack.
virtual int open (NetworkStack *iface)
 Opens a socket.
int listen (int backlog=1)
 Listen for connections on a TCP socket.
int accept (TCPSocket *connection)
 Accepts a connection on a TCP 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

TCP socket server.

Definition at line 26 of file TCPServer.h.

Constructor & Destructor Documentation

TCPServer (  )

Create an uninitialized socket.

Must call open to initialize the socket on a network stack.

Definition at line 20 of file TCPServer.cpp.

TCPServer ( NetworkStack *  iface )

Create a socket on a network stack.

Creates and opens a socket on the specified network stack.

Parameters:
ifaceNetwork stack as target for socket

Definition at line 24 of file TCPServer.cpp.

Member Function Documentation

int accept ( TCPSocket *  connection )

Accepts a connection on a TCP socket.

The server socket must be bound and set to listen for connections. On a new connection, creates a network socket using the specified socket instance.

By default, accept blocks until data is sent. If socket is set to non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

Parameters:
socketTCPSocket instance that will handle the incoming connection.
Returns:
0 on success, negative error code on failure

Definition at line 43 of file TCPServer.cpp.

void attach ( FunctionPointer  callback ) [inherited]

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:
callbackFunction to call on state change

Definition at line 124 of file Socket.cpp.

void attach ( T *  tptr,
M  mptr 
) [inherited]

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:
tptrPointer to object to call method on
mptrMethod to call on state change

Definition at line 163 of file Socket.h.

int bind ( const SocketAddress &  address ) [inherited]

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:
addressLocal address to bind
Returns:
0 on success, negative error code on failure.

Definition at line 74 of file Socket.cpp.

int bind ( uint16_t  port ) [inherited]

Bind a specific address to a socket.

Binding a socket specifies the address and port on which to recieve data.

Parameters:
portLocal port to bind
Returns:
0 on success, negative error code on failure.

Definition at line 62 of file Socket.cpp.

int bind ( const char *  address,
uint16_t  port 
) [inherited]

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:
addressNull-terminated local address to bind
portLocal port to bind
Returns:
0 on success, negative error code on failure.

Definition at line 68 of file Socket.cpp.

int close (  ) [inherited]

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.

int listen ( int  backlog = 1 )

Listen for connections on a TCP socket.

Marks the socket as a passive socket that can be used to accept incoming connections.

Parameters:
backlogNumber of pending connections that can be queued simultaneously, defaults to 1
Returns:
0 on success, negative error code on failure

Definition at line 34 of file TCPServer.cpp.

int open ( NetworkStack *  iface ) [virtual]

Opens a socket.

Creates a network socket on the specified network stack. Not needed if stack is passed to the socket's constructor.

Parameters:
ifaceNetwork stack as target for socket
Returns:
0 on success, negative error code on failure

Implements Socket.

Definition at line 29 of file TCPServer.cpp.

void set_blocking ( bool  blocking ) [inherited]

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:
blockingtrue for blocking mode, false for non-blocking mode.

Definition at line 83 of file Socket.cpp.

void set_timeout ( int  timeout ) [inherited]

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:
timeoutTimeout in milliseconds

Definition at line 88 of file Socket.cpp.

Generated on Wed Jul 13 2022 20:28:49 by  doxygen 1.7.2