This module includes functions that control TCP communication.

Classes

struct  otLinkedBuffer
 A linked buffer structure for use with TCP.
 
struct  otTcpEndpoint
 This structure represents a TCP endpoint.
 
struct  otTcpEndpointInitializeArgs
 This structure contains arguments to the otTcpEndpointInitialize() function.
 
struct  otTcpListener
 This structure represents a TCP listener.
 
struct  otTcpListenerInitializeArgs
 This structure contains arguments to the otTcpListenerInitialize() function.

Macros

#define OT_TCP_ENDPOINT_TCB_SIZE_BASE   368
 OT_TCP_ENDPOINT_TCB_SIZE_BASE and OT_TCP_ENDPOINT_TCB_NUM_POINTERS are chosen such that the mTcb field of otTcpEndpoint has the same size as struct tcpcb in TCPlp.
 
#define OT_TCP_ENDPOINT_TCB_NUM_PTR   36
 
#define OT_TCP_RECEIVE_BUFFER_SIZE_FEW_HOPS   2598
 Recommended buffer size for TCP connections that traverse about 3 wireless hops or fewer.
 
#define OT_TCP_RECEIVE_BUFFER_SIZE_MANY_HOPS   4157
 Recommended buffer size for TCP connections that traverse many wireless hops.
 
#define OT_TCP_LISTENER_TCB_SIZE_BASE   16
 OT_TCP_LISTENER_TCB_SIZE_BASE and OT_TCP_LISTENER_TCB_NUM_POINTERS are chosen such that the mTcbListener field of otTcpListener has the same size as struct tcpcb_listen in TCPlp.
 
#define OT_TCP_LISTENER_TCB_NUM_PTR   3

Typedefs

typedef struct otLinkedBuffer otLinkedBuffer
 A linked buffer structure for use with TCP.
 
typedef struct otTcpEndpoint otTcpEndpoint
 
typedef void(* otTcpEstablished) (otTcpEndpoint *aEndpoint)
 This callback informs the application that the TCP 3-way handshake is complete and that the connection is now established.
 
typedef void(* otTcpSendDone) (otTcpEndpoint *aEndpoint, otLinkedBuffer *aData)
 This callback informs the application that data in the provided aData have been acknowledged by the connection peer and that aData and the data it contains can be reclaimed by the application.
 
typedef void(* otTcpForwardProgress) (otTcpEndpoint *aEndpoint, size_t aInSendBuffer, size_t aBacklog)
 This callback informs the application if forward progress has been made in transferring data from the send buffer to the recipient.
 
typedef void(* otTcpReceiveAvailable) (otTcpEndpoint *aEndpoint, size_t aBytesAvailable, bool aEndOfStream, size_t aBytesRemaining)
 This callback indicates the number of bytes available for consumption from the receive buffer.
 
typedef enum otTcpDisconnectedReason otTcpDisconnectedReason
 
typedef void(* otTcpDisconnected) (otTcpEndpoint *aEndpoint, otTcpDisconnectedReason aReason)
 This callback indicates that the connection was broken and should no longer be used, or that a connection has entered the TIME-WAIT state.
 
typedef struct otTcpEndpointInitializeArgs otTcpEndpointInitializeArgs
 This structure contains arguments to the otTcpEndpointInitialize() function.
 
typedef struct otTcpListener otTcpListener
 
typedef enum otTcpIncomingConnectionAction otTcpIncomingConnectionAction
 This enumeration defines incoming connection actions.
 
typedef otTcpIncomingConnectionAction(* otTcpAcceptReady) (otTcpListener *aListener, const otSockAddr *aPeer, otTcpEndpoint **aAcceptInto)
 This callback indicates that an incoming connection that matches this TCP listener has arrived.
 
typedef void(* otTcpAcceptDone) (otTcpListener *aListener, otTcpEndpoint *aEndpoint, const otSockAddr *aPeer)
 This callback indicates that the TCP connection is now ready for two-way communication.
 
typedef struct otTcpListenerInitializeArgs otTcpListenerInitializeArgs
 This structure contains arguments to the otTcpListenerInitialize() function.

Enumerations

enum  otTcpDisconnectedReason {
  OT_TCP_DISCONNECTED_REASON_NORMAL,
  OT_TCP_DISCONNECTED_REASON_REFUSED,
  OT_TCP_DISCONNECTED_REASON_RESET,
  OT_TCP_DISCONNECTED_REASON_TIME_WAIT,
  OT_TCP_DISCONNECTED_REASON_TIMED_OUT
}
 
enum  { OT_TCP_CONNECT_NO_FAST_OPEN = 1 << 0 }
 This enumeration defines flags passed to otTcpConnect().
 
enum  { OT_TCP_SEND_MORE_TO_COME = 1 << 0 }
 This enumeration defines flags passed to otTcpSendByReference.
 
enum  otTcpIncomingConnectionAction {
  OT_TCP_INCOMING_CONNECTION_ACTION_ACCEPT,
  OT_TCP_INCOMING_CONNECTION_ACTION_DEFER,
  OT_TCP_INCOMING_CONNECTION_ACTION_REFUSE
}
 This enumeration defines incoming connection actions.

Functions

otError otTcpEndpointInitialize (otInstance *aInstance, otTcpEndpoint *aEndpoint, const otTcpEndpointInitializeArgs *aArgs)
 Initializes a TCP endpoint.
 
otInstanceotTcpEndpointGetInstance (otTcpEndpoint *aEndpoint)
 Obtains the otInstance that was associated with aEndpoint upon initialization.
 
void * otTcpEndpointGetContext (otTcpEndpoint *aEndpoint)
 Obtains the context pointer that was associated with aEndpoint upon initialization.
 
const otSockAddrotTcpGetLocalAddress (const otTcpEndpoint *aEndpoint)
 Obtains a pointer to a TCP endpoint's local host and port.
 
const otSockAddrotTcpGetPeerAddress (const otTcpEndpoint *aEndpoint)
 Obtains a pointer to a TCP endpoint's peer's host and port.
 
otError otTcpBind (otTcpEndpoint *aEndpoint, const otSockAddr *aSockName)
 Binds the TCP endpoint to an IP address and port.
 
otError otTcpConnect (otTcpEndpoint *aEndpoint, const otSockAddr *aSockName, uint32_t aFlags)
 Records the remote host and port for this connection.
 
otError otTcpSendByReference (otTcpEndpoint *aEndpoint, otLinkedBuffer *aBuffer, uint32_t aFlags)
 Adds data referenced by the linked buffer pointed to by aBuffer to the send buffer.
 
otError otTcpSendByExtension (otTcpEndpoint *aEndpoint, size_t aNumBytes, uint32_t aFlags)
 Adds data to the send buffer by extending the length of the final otLinkedBuffer in the send buffer by the specified amount.
 
otError otTcpReceiveByReference (otTcpEndpoint *aEndpoint, const otLinkedBuffer **aBuffer)
 Provides the application with a linked buffer chain referencing data currently in the TCP receive buffer.
 
otError otTcpReceiveContiguify (otTcpEndpoint *aEndpoint)
 Reorganizes the receive buffer to be entirely contiguous in memory.
 
otError otTcpCommitReceive (otTcpEndpoint *aEndpoint, size_t aNumBytes, uint32_t aFlags)
 Informs the TCP stack that the application has finished processing aNumBytes bytes of data at the start of the receive buffer and that the TCP stack need not continue maintaining those bytes in the receive buffer.
 
otError otTcpSendEndOfStream (otTcpEndpoint *aEndpoint)
 Informs the connection peer that this TCP endpoint will not send more data.
 
otError otTcpAbort (otTcpEndpoint *aEndpoint)
 Forcibly ends the TCP connection associated with this TCP endpoint.
 
otError otTcpEndpointDeinitialize (otTcpEndpoint *aEndpoint)
 Deinitializes this TCP endpoint.
 
otError otTcpListenerInitialize (otInstance *aInstance, otTcpListener *aListener, const otTcpListenerInitializeArgs *aArgs)
 Initializes a TCP listener.
 
otInstanceotTcpListenerGetInstance (otTcpListener *aListener)
 Obtains the otInstance that was associated with aListener upon initialization.
 
void * otTcpListenerGetContext (otTcpListener *aListener)
 Obtains the context pointer that was associated with aListener upon initialization.
 
otError otTcpListen (otTcpListener *aListener, const otSockAddr *aSockName)
 Causes incoming TCP connections that match the specified IP address and port to trigger this TCP listener's callbacks.
 
otError otTcpStopListening (otTcpListener *aListener)
 Causes this TCP listener to stop listening for incoming connections.
 
otError otTcpListenerDeinitialize (otTcpListener *aListener)
 Deinitializes this TCP listener.

Detailed Description

This module includes functions that control TCP communication.

Macro Definition Documentation

◆ OT_TCP_ENDPOINT_TCB_SIZE_BASE

#define OT_TCP_ENDPOINT_TCB_SIZE_BASE   368

OT_TCP_ENDPOINT_TCB_SIZE_BASE and OT_TCP_ENDPOINT_TCB_NUM_POINTERS are chosen such that the mTcb field of otTcpEndpoint has the same size as struct tcpcb in TCPlp.

This is necessary because the mTcb field, although opaque in its declaration, is treated as struct tcpcb in the TCP implementation.

◆ OT_TCP_LISTENER_TCB_SIZE_BASE

#define OT_TCP_LISTENER_TCB_SIZE_BASE   16

OT_TCP_LISTENER_TCB_SIZE_BASE and OT_TCP_LISTENER_TCB_NUM_POINTERS are chosen such that the mTcbListener field of otTcpListener has the same size as struct tcpcb_listen in TCPlp.

This is necessary because the mTcbListen field, though opaque in its declaration, is treated as struct tcpcb in the TCP implementation.

◆ OT_TCP_RECEIVE_BUFFER_SIZE_FEW_HOPS

#define OT_TCP_RECEIVE_BUFFER_SIZE_FEW_HOPS   2598

Recommended buffer size for TCP connections that traverse about 3 wireless hops or fewer.

On platforms where memory is particularly constrained and in situations where high bandwidth is not necessary, it may be desirable to manually select a smaller buffer size.

◆ OT_TCP_RECEIVE_BUFFER_SIZE_MANY_HOPS

#define OT_TCP_RECEIVE_BUFFER_SIZE_MANY_HOPS   4157

Recommended buffer size for TCP connections that traverse many wireless hops.

If the TCP connection traverses a very large number of hops (more than 6 or so), then it may be advisable to select a large buffer size manually.

Typedef Documentation

◆ otLinkedBuffer

A linked buffer structure for use with TCP.

A single otLinkedBuffer structure references an array of bytes in memory, via mData and mLength. The mNext field is used to form a chain of otLinkedBuffer structures.

◆ otTcpAcceptDone

typedef void(* otTcpAcceptDone) (otTcpListener *aListener, otTcpEndpoint *aEndpoint, const otSockAddr *aPeer)

This callback indicates that the TCP connection is now ready for two-way communication.

In the case of TCP Fast Open, this may be before the TCP connection handshake has actually completed. The application is provided with the context pointers both for the TCP listener that accepted the connection and the TCP endpoint into which it was accepted. The provided context is the one associated with the TCP listener.

Parameters
[in]aListenerThe TCP listener that matches the incoming connection.
[in]aEndpointThe TCP endpoint into which the incoming connection was accepted.
[in]aPeerthe host and port from which the incoming connection originated.

◆ otTcpAcceptReady

typedef otTcpIncomingConnectionAction(* otTcpAcceptReady) (otTcpListener *aListener, const otSockAddr *aPeer, otTcpEndpoint **aAcceptInto)

This callback indicates that an incoming connection that matches this TCP listener has arrived.

The typical response is for the application to accept the incoming connection. It does so by populating aAcceptInto with a pointer to the otTcpEndpoint into which to accept the incoming connection. This otTcpEndpoint must already be initialized using otTcpEndpointInitialize(). Then, the application returns OT_TCP_INCOMING_CONNECTION_ACTION_ACCEPT.

Alternatively, the application can decline to accept the incoming connection. There are two ways for the application to do this. First, if the application returns OT_TCP_INCOMING_CONNECTION_ACTION_DEFER, then OpenThread silently ignores the connection establishment request; the connection peer will likely retransmit the request, at which point the callback will be called again. This is valuable if resources are not presently available to accept the connection, but they may be available when the connection peer retransmits its connection establishment attempt. Second, if the application returns OT_TCP_INCOMING_CONNECTION_ACTION_REFUSE, then OpenThread sends a "connection refused" message to the host that attempted to establish a connection. If the application declines the incoming connection, it is not required to populate aAcceptInto.

Parameters
[in]aListenerThe TCP listener that matches the incoming connection.
[in]aPeerThe host and port from which the incoming connection originates.
[out]aAcceptIntoThe TCP endpoint into which to accept the incoming connection.
Returns
Description of how to handle the incoming connection.

◆ otTcpDisconnected

typedef void(* otTcpDisconnected) (otTcpEndpoint *aEndpoint, otTcpDisconnectedReason aReason)

This callback indicates that the connection was broken and should no longer be used, or that a connection has entered the TIME-WAIT state.

It can occur if a connection establishment attempt (initiated by calling otTcpConnect()) fails, or any point thereafter (e.g., if the connection times out or an RST segment is received from the connection peer). Once this callback fires, all resources that the application provided for this connection (i.e., any otLinkedBuffers and memory they reference, but not the TCP endpoint itself or space for the receive buffers) can be reclaimed. In the case of a connection entering the TIME-WAIT state, this callback is called twice, once upon entry into the TIME-WAIT state (with OT_TCP_DISCONNECTED_REASON_TIME_WAIT, and again when the TIME-WAIT state expires (with OT_TCP_DISCONNECTED_REASON_NORMAL).

Parameters
[in]aEndpointThe TCP endpoint whose connection has been lost.
[in]aReasonThe reason why the connection was lost.

◆ otTcpEstablished

typedef void(* otTcpEstablished) (otTcpEndpoint *aEndpoint)

This callback informs the application that the TCP 3-way handshake is complete and that the connection is now established.

Parameters
[in]aEndpointThe TCP endpoint whose connection is now established.

◆ otTcpForwardProgress

typedef void(* otTcpForwardProgress) (otTcpEndpoint *aEndpoint, size_t aInSendBuffer, size_t aBacklog)

This callback informs the application if forward progress has been made in transferring data from the send buffer to the recipient.

This callback is not necessary for correct TCP operation. Most applications can just rely on the otTcpSendDone() callback to reclaim linked buffers once the TCP stack is done using them. The purpose of this callback is to support advanced applications that benefit from finer-grained information about how the the connection is making forward progress in transferring data to the connection peer.

This callback's operation is closely tied to TCP's send buffer. The send buffer can be understood as having two regions. First, there is the "in-flight" region at the head (front) of the send buffer. It corresponds to data which has been sent to the recipient, but is not yet acknowledged. Second, there is the "backlog" region, which consists of all data in the send buffer that is not in the "in-flight" region. The "backlog" region corresponds to data that is queued for sending, but has not yet been sent.

The callback is invoked in response to two types of events. First, the "in-flight" region of the send buffer may shrink (e.g., when the recipient acknowledges data that we sent earlier). Second, the "backlog" region of the send buffer may shrink (e.g., new data was sent out). These two conditions often occur at the same time, in response to an ACK segment from the connection peer, which is why they are combined in a single callback.

The TCP stack only uses the aInSendBuffer bytes at the tail of the send buffer; when aInSendBuffer decreases by an amount x, it means that x additional bytes that were formerly at the head of the send buffer are no longer part of the send buffer and can now be reclaimed (i.e., overwritten) by the application. Note that the otLinkedBuffer structure itself can only be reclaimed once all bytes that it references are no longer part of the send buffer.

This callback subsumes otTcpSendDone(), in the following sense: applications can determine when linked buffers can be reclaimed by comparing aInSendBuffer with how many bytes are in each linked buffer. However, we expect otTcpSendDone(), which directly conveys which otLinkedBuffers can be reclaimed, to be much simpler to use. If both callbacks are registered and are triggered by the same event (e.g., the same ACK segment received), then the otTcpSendDone() callback will be triggered first, followed by this callback.

Additionally, this callback provides aBacklog, which indicates how many bytes of data in the send buffer are not yet in flight. For applications that only want to add data to the send buffer when there is an assurance that it will be sent out soon, it may be desirable to only send out data when aBacklog is suitably small (0 or close to 0). For example, an application may use aBacklog so that it can react to queue buildup by dropping or aggregating data to avoid creating a backlog of data.

After a call to otTcpSendByReference() or otTcpSendByExtension() with a positive number of bytes, the otTcpForwardProgress() callback is guaranteed to be called, to indicate when the bytes that were added to the send buffer are sent out. The call to otTcpForwardProgress() may be made immediately after the bytes are added to the send buffer (if some of those bytes are immediately sent out, reducing the backlog), or sometime in the future (once the connection sends out some or all of the data, reducing the backlog). By "immediately," we mean that the callback is immediately scheduled for execution in a tasklet; to avoid reentrancy-related complexity, the otTcpForwardProgress() callback is never directly called from the otTcpSendByReference() or otTcpSendByExtension() functions.

Parameters
[in]aEndpointThe TCP endpoint for the connection.
[in]aInSendBufferThe number of bytes in the send buffer (sum of "in-flight" and "backlog" regions).
[in]aBacklogThe number of bytes that are queued for sending but have not yet been sent (the "backlog" region).

◆ otTcpIncomingConnectionAction

This enumeration defines incoming connection actions.

This is used in otTcpAcceptReady() callback.

◆ otTcpReceiveAvailable

typedef void(* otTcpReceiveAvailable) (otTcpEndpoint *aEndpoint, size_t aBytesAvailable, bool aEndOfStream, size_t aBytesRemaining)

This callback indicates the number of bytes available for consumption from the receive buffer.

It is called whenever bytes are added to the receive buffer and when the end of stream is reached. If the end of the stream has been reached (i.e., if no more data will become available to read because the connection peer has closed their end of the connection for writing), then aEndOfStream is true. Finally, aBytesRemaining indicates how much capacity is left in the receive buffer to hold additional data that arrives.

Parameters
[in]aEndpointThe TCP endpoint for the connection.
[in]aBytesAvailableThe number of bytes in the connection's receive buffer.
[in]aEndOfStreamIndicates if additional data, beyond what is already in the connection's receive buffer, can be received.
[in]aBytesRemainingThe number of additional bytes that can be received before the receive buffer becomes full.

◆ otTcpSendDone

typedef void(* otTcpSendDone) (otTcpEndpoint *aEndpoint, otLinkedBuffer *aData)

This callback informs the application that data in the provided aData have been acknowledged by the connection peer and that aData and the data it contains can be reclaimed by the application.

The aData are guaranteed to be identical to those passed in to TCP via otTcpSendByReference(), including any extensions effected via otTcpSendByExtension().

Parameters
[in]aEndpointThe TCP endpoint for the connection.
[in]aDataA pointer to the otLinkedBuffer that can be reclaimed.

Enumeration Type Documentation

◆ otTcpIncomingConnectionAction

This enumeration defines incoming connection actions.

This is used in otTcpAcceptReady() callback.

Enumerator
OT_TCP_INCOMING_CONNECTION_ACTION_ACCEPT 

Accept the incoming connection.

OT_TCP_INCOMING_CONNECTION_ACTION_DEFER 

Defer (silently ignore) the incoming connection.

OT_TCP_INCOMING_CONNECTION_ACTION_REFUSE 

Refuse the incoming connection.

Function Documentation

◆ otTcpAbort()

otError otTcpAbort ( otTcpEndpoint aEndpoint)

Forcibly ends the TCP connection associated with this TCP endpoint.

This immediately makes the TCP endpoint free for use for another connection and empties the send and receive buffers, transferring ownership of any data provided by the application in otTcpSendByReference() and otTcpSendByExtension() calls back to the application. The TCP endpoint's callbacks and memory for the receive buffer remain associated with the TCP endpoint.

Parameters
[in]aEndpointA pointer to the TCP endpoint structure representing the TCP endpoint to abort.
Return values
OT_ERROR_NONESuccessfully aborted the TCP endpoint's connection.
OT_ERROR_FAILEDFailed to abort the TCP endpoint's connection.

◆ otTcpBind()

otError otTcpBind ( otTcpEndpoint aEndpoint,
const otSockAddr aSockName 
)

Binds the TCP endpoint to an IP address and port.

Parameters
[in]aEndpointA pointer to the TCP endpoint structure to bind.
[in]aSockNameThe address and port to which to bind this TCP endpoint.
Return values
OT_ERROR_NONESuccessfully bound the TCP endpoint.
OT_ERROR_FAILEDFailed to bind the TCP endpoint.

◆ otTcpCommitReceive()

otError otTcpCommitReceive ( otTcpEndpoint aEndpoint,
size_t  aNumBytes,
uint32_t  aFlags 
)

Informs the TCP stack that the application has finished processing aNumBytes bytes of data at the start of the receive buffer and that the TCP stack need not continue maintaining those bytes in the receive buffer.

Parameters
[in]aEndpointA pointer to the TCP endpoint structure representing the TCP endpoint on which to receive data.
[in]aNumBytesThe number of bytes consumed.
[in]aFlagsFlags specifying options for this operation (none yet).
Return values
OT_ERROR_NONESuccessfully completed the receive operation.
OT_ERROR_FAILEDFailed to complete the receive operation.

◆ otTcpConnect()

otError otTcpConnect ( otTcpEndpoint aEndpoint,
const otSockAddr aSockName,
uint32_t  aFlags 
)

Records the remote host and port for this connection.

By default TCP Fast Open is used. This means that this function merely records the remote host and port, and that the TCP connection establishment handshake only happens on the first call to otTcpSendByReference(). TCP Fast Open can be explicitly disabled using aFlags, in which case the TCP connection establishment handshake is initiated immediately.

Parameters
[in]aEndpointA pointer to the TCP endpoint structure to connect.
[in]aSockNameThe IP address and port of the host to which to connect.
[in]aFlagsFlags specifying options for this operation (see enumeration above).
Return values
OT_ERROR_NONESuccessfully completed the operation.
OT_ERROR_FAILEDFailed to complete the operation.

◆ otTcpEndpointDeinitialize()

otError otTcpEndpointDeinitialize ( otTcpEndpoint aEndpoint)

Deinitializes this TCP endpoint.

This means that OpenThread no longer keeps track of this TCP endpoint and deallocates all resources it has internally allocated for this TCP endpoint. The application can reuse the memory backing the TCP endpoint as it sees fit.

If it corresponds to a live TCP connection, the connection is terminated unceremoniously (as in otTcpAbort()). All resources the application has provided for this TCP endpoint (linked buffers for the send buffer, memory for the receive buffer, the aEndpoint structure itself, etc.) are immediately returned to the application.

Parameters
[in]aEndpointA pointer to the TCP endpoint structure to deinitialize.
Return values
OT_ERROR_NONESuccessfully deinitialized the TCP endpoint.
OT_ERROR_FAILEDFailed to deinitialize the TCP endpoint.

◆ otTcpEndpointGetContext()

void* otTcpEndpointGetContext ( otTcpEndpoint aEndpoint)

Obtains the context pointer that was associated with aEndpoint upon initialization.

Parameters
[in]aEndpointThe TCP endpoint whose context to obtain.
Returns
The context pointer associated with aEndpoint.

◆ otTcpEndpointGetInstance()

otInstance* otTcpEndpointGetInstance ( otTcpEndpoint aEndpoint)

Obtains the otInstance that was associated with aEndpoint upon initialization.

Parameters
[in]aEndpointThe TCP endpoint whose instance to obtain.
Returns
The otInstance pointer associated with aEndpoint.

◆ otTcpEndpointInitialize()

otError otTcpEndpointInitialize ( otInstance aInstance,
otTcpEndpoint aEndpoint,
const otTcpEndpointInitializeArgs aArgs 
)

Initializes a TCP endpoint.

Calling this function causes OpenThread to keep track of the TCP endpoint and store and retrieve TCP data inside the aEndpoint. The application should refrain from directly accessing or modifying the fields in aEndpoint. If the application needs to reclaim the memory backing aEndpoint, it should call otTcpEndpointDeinitialize().

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aEndpointA pointer to a TCP endpoint structure.
[in]aArgsA pointer to a structure of arguments.
Return values
OT_ERROR_NONESuccessfully opened the TCP endpoint.
OT_ERROR_FAILEDFailed to open the TCP endpoint.

◆ otTcpGetLocalAddress()

const otSockAddr* otTcpGetLocalAddress ( const otTcpEndpoint aEndpoint)

Obtains a pointer to a TCP endpoint's local host and port.

The contents of the host and port may be stale if this socket is not in a connected state and has not been bound after it was last disconnected.

Parameters
[in]aEndpointThe TCP endpoint whose local host and port to obtain.
Returns
The local host and port of aEndpoint.

◆ otTcpGetPeerAddress()

const otSockAddr* otTcpGetPeerAddress ( const otTcpEndpoint aEndpoint)

Obtains a pointer to a TCP endpoint's peer's host and port.

The contents of the host and port may be stale if this socket is not in a connected state.

Parameters
[in]aEndpointThe TCP endpoint whose peer's host and port to obtain.
Returns
The host and port of the connection peer of aEndpoint.

◆ otTcpListen()

otError otTcpListen ( otTcpListener aListener,
const otSockAddr aSockName 
)

Causes incoming TCP connections that match the specified IP address and port to trigger this TCP listener's callbacks.

Parameters
[in]aListenerA pointer to the TCP listener structure that should begin listening.
[in]aSockNameThe address and port on which to listen for incoming connections.
Return values
OT_ERROR_NONESuccessfully initiated listening on the TCP listener.
OT_ERROR_FAILEDFailed to initiate listening on the TCP listener.

◆ otTcpListenerDeinitialize()

otError otTcpListenerDeinitialize ( otTcpListener aListener)

Deinitializes this TCP listener.

This means that OpenThread no longer keeps track of this TCP listener and deallocates all resources it has internally allocated for this TCP listener. The application can reuse the memory backing the TCP listener as it sees fit.

If the TCP listener is currently listening, it stops listening.

Parameters
[in]aListenerA pointer to the TCP listener structure to deinitialize.
Return values
OT_ERROR_NONESuccessfully deinitialized the TCP listener.
OT_ERROR_FAILEDFailed to deinitialize the TCP listener.

◆ otTcpListenerGetContext()

void* otTcpListenerGetContext ( otTcpListener aListener)

Obtains the context pointer that was associated with aListener upon initialization.

Parameters
[in]aListenerThe TCP listener whose context to obtain.
Returns
The context pointer associated with aListener.

◆ otTcpListenerGetInstance()

otInstance* otTcpListenerGetInstance ( otTcpListener aListener)

Obtains the otInstance that was associated with aListener upon initialization.

Parameters
[in]aListenerThe TCP listener whose instance to obtain.
Returns
The otInstance pointer associated with aListener.

◆ otTcpListenerInitialize()

otError otTcpListenerInitialize ( otInstance aInstance,
otTcpListener aListener,
const otTcpListenerInitializeArgs aArgs 
)

Initializes a TCP listener.

Calling this function causes OpenThread to keep track of the TCP listener and store and retrieve TCP data inside aListener. The application should refrain from directly accessing or modifying the fields in aListener. If the application needs to reclaim the memory backing aListener, it should call otTcpListenerDeinitialize().

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aListenerA pointer to a TCP listener structure.
[in]aArgsA pointer to a structure of arguments.
Return values
OT_ERROR_NONESuccessfully opened the TCP listener.
OT_ERROR_FAILEDFailed to open the TCP listener.

◆ otTcpReceiveByReference()

otError otTcpReceiveByReference ( otTcpEndpoint aEndpoint,
const otLinkedBuffer **  aBuffer 
)

Provides the application with a linked buffer chain referencing data currently in the TCP receive buffer.

The linked buffer chain is valid until the "receive ready" callback is next invoked, or until the next call to otTcpReceiveContiguify() or otTcpCommitReceive().

Parameters
[in]aEndpointA pointer to the TCP endpoint structure representing the TCP endpoint on which to receive data.
[out]aBufferA pointer to the linked buffer chain referencing data currently in the receive buffer.
Return values
OT_ERROR_NONESuccessfully completed the operation.
OT_ERROR_FAILEDFailed to complete the operation.

◆ otTcpReceiveContiguify()

otError otTcpReceiveContiguify ( otTcpEndpoint aEndpoint)

Reorganizes the receive buffer to be entirely contiguous in memory.

This is optional; an application can simply traverse the linked buffer chain obtained by calling otTcpReceiveByReference. Some applications may wish to call this function to make the receive buffer contiguous to simplify their data processing, but this comes at the expense of CPU time to reorganize the data in the receive buffer.

Parameters
[in]aEndpointA pointer to the TCP endpoint whose receive buffer to reorganize.
Return values
OT_ERROR_NONESuccessfully completed the operation.
OT_ERROR_FAILEDFailed to complete the operation.

◆ otTcpSendByExtension()

otError otTcpSendByExtension ( otTcpEndpoint aEndpoint,
size_t  aNumBytes,
uint32_t  aFlags 
)

Adds data to the send buffer by extending the length of the final otLinkedBuffer in the send buffer by the specified amount.

If the send buffer is empty, then the operation fails.

Parameters
[in]aEndpointA pointer to the TCP endpoint structure representing the TCP endpoint on which to send data.
[in]aNumBytesThe number of bytes by which to extend the length of the final linked buffer.
[in]aFlagsFlags specifying options for this operation (see enumeration above).
Return values
OT_ERROR_NONESuccessfully added data to the send buffer.
OT_ERROR_FAILEDFailed to add data to the send buffer.

◆ otTcpSendByReference()

otError otTcpSendByReference ( otTcpEndpoint aEndpoint,
otLinkedBuffer aBuffer,
uint32_t  aFlags 
)

Adds data referenced by the linked buffer pointed to by aBuffer to the send buffer.

Upon a successful call to this function, the linked buffer and data it references are owned by the TCP stack; they should not be modified by the application until a "send done" callback returns ownership of those objects to the application. It is acceptable to call this function to add another linked buffer to the send queue, even if the "send done" callback for a previous invocation of this function has not yet fired.

Note that aBuffer should not be chained; its mNext field should be NULL. If additional data will be added right after this call, then the OT_TCP_SEND_MORE_TO_COME flag should be used as a hint to the TCP implementation.

Parameters
[in]aEndpointA pointer to the TCP endpoint structure representing the TCP endpoint on which to send data.
[in]aBufferA pointer to the linked buffer chain referencing data to add to the send buffer.
[in]aFlagsFlags specifying options for this operation (see enumeration above).
Return values
OT_ERROR_NONESuccessfully added data to the send buffer.
OT_ERROR_FAILEDFailed to add data to the send buffer.

◆ otTcpSendEndOfStream()

otError otTcpSendEndOfStream ( otTcpEndpoint aEndpoint)

Informs the connection peer that this TCP endpoint will not send more data.

This should be used when the application has no more data to send to the connection peer. For this connection, future reads on the connection peer will result in the "end of stream" condition, and future writes on this connection endpoint will fail.

The "end of stream" condition only applies after any data previously provided to the TCP stack to send out has been received by the connection peer.

Parameters
[in]aEndpointA pointer to the TCP endpoint structure representing the TCP endpoint to shut down.
Return values
OT_ERROR_NONESuccessfully queued the "end of stream" condition for transmission.
OT_ERROR_FAILEDFailed to queue the "end of stream" condition for transmission.

◆ otTcpStopListening()

otError otTcpStopListening ( otTcpListener aListener)

Causes this TCP listener to stop listening for incoming connections.

Parameters
[in]aListenerA pointer to the TCP listener structure that should stop listening.
Return values
OT_ERROR_NONESuccessfully stopped listening on the TCP listener.
OT_ERROR_FAILEDFailed to stop listening on the TCP listener.