otTcpEndpoint

#include <tcp.h>

Represents a TCP endpoint.

Summary

A TCP endpoint acts an endpoint of TCP connection. It can be used to initiate TCP connections, and, once a TCP connection is established, send data to and receive data from the connection peer.

The application should not inspect the fields of this structure directly; it should only interact with it via the TCP API functions whose signatures are provided in this file.

Public attributes

mAlign
uint64_t
mContext
void *
A pointer to application-specific context.
mDisconnectedCallback
"Disconnected" callback function
mEstablishedCallback
"Established" callback function
mForwardProgressCallback
"Forward progress" callback function
mNext
struct otTcpEndpoint *
A pointer to the next TCP endpoint (internal use only)
mPendingCallbacks
uint8_t
mReceiveAvailableCallback
"Receive available" callback function
mReceiveLinks[2]
mSendDoneCallback
"Send done" callback function
mSize[392+36 *sizeof(void *)]
uint8_t
mSockAddr
mTcb
union otTcpEndpoint::@24
mTimers[4]
uint32_t

Public attributes

mAlign

uint64_t otTcpEndpoint::mAlign

mContext

void * otTcpEndpoint::mContext

A pointer to application-specific context.

mDisconnectedCallback

otTcpDisconnected otTcpEndpoint::mDisconnectedCallback

"Disconnected" callback function

mEstablishedCallback

otTcpEstablished otTcpEndpoint::mEstablishedCallback

"Established" callback function

mForwardProgressCallback

otTcpForwardProgress otTcpEndpoint::mForwardProgressCallback

"Forward progress" callback function

mNext

struct otTcpEndpoint * otTcpEndpoint::mNext

A pointer to the next TCP endpoint (internal use only)

mPendingCallbacks

uint8_t otTcpEndpoint::mPendingCallbacks

mReceiveAvailableCallback

otTcpReceiveAvailable otTcpEndpoint::mReceiveAvailableCallback

"Receive available" callback function

otLinkedBuffer otTcpEndpoint::mReceiveLinks[2]

mSendDoneCallback

otTcpSendDone otTcpEndpoint::mSendDoneCallback

"Send done" callback function

mSize

uint8_t otTcpEndpoint::mSize[392+36 *sizeof(void *)]

mSockAddr

otSockAddr otTcpEndpoint::mSockAddr

mTcb

union otTcpEndpoint::@24 otTcpEndpoint::mTcb

mTimers

uint32_t otTcpEndpoint::mTimers[4]

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.