Parameters involved in sending/receiving data through sockets. More...

#include <cellular_common.h>

Data Fields
uint8_t	contextId

uint32_t	socketId

CellularSocketState_t	socketState

CellularSocketType_t	socketType

CellularSocketDomain_t	socketDomain

CellularSocketProtocol_t	socketProtocol

CellularIPAddress_t	localIpAddress

uint16_t	localPort

CellularSocketAccessMode_t	dataMode

uint32_t	sendTimeoutMs

uint32_t	recvTimeoutMs

CellularSocketAddress_t	remoteSocketAddress

CellularSocketDataReadyCallback_t	dataReadyCallback

void *	pDataReadyCallbackContext

CellularSocketOpenCallback_t	openCallback

void *	pOpenCallbackContext

CellularSocketClosedCallback_t	closedCallback

void *	pClosedCallbackContext

void *	pModemData

Detailed Description

Parameters involved in sending/receiving data through sockets.

Field Documentation

◆ contextId

uint8_t CellularSocketContext_t::contextId

PDN context ID on which this socket exists.

◆ socketId

uint32_t CellularSocketContext_t::socketId

Socket ID of this socket.

◆ socketState

CellularSocketState_t CellularSocketContext_t::socketState

State of the socket, Allocated, Free etc.

◆ socketType

CellularSocketType_t CellularSocketContext_t::socketType

Type of socket, DGRAM or STREAM.

◆ socketDomain

CellularSocketDomain_t CellularSocketContext_t::socketDomain

Socket domain, IPV4 or V6.

◆ socketProtocol

CellularSocketProtocol_t CellularSocketContext_t::socketProtocol

Socket transport protocol, TCP or UDP.

◆ localIpAddress

CellularIPAddress_t CellularSocketContext_t::localIpAddress

IP address assigned to the device.

◆ localPort

uint16_t CellularSocketContext_t::localPort

Local Port.

◆ dataMode

CellularSocketAccessMode_t CellularSocketContext_t::dataMode

Data Access mode enabled for this socket.

◆ sendTimeoutMs

uint32_t CellularSocketContext_t::sendTimeoutMs

Send timeout value in milliseconds.

◆ recvTimeoutMs

uint32_t CellularSocketContext_t::recvTimeoutMs

Receive timeout value in milliseconds.

◆ remoteSocketAddress

CellularSocketAddress_t CellularSocketContext_t::remoteSocketAddress

Remote IP address and port.

◆ dataReadyCallback

CellularSocketDataReadyCallback_t CellularSocketContext_t::dataReadyCallback

Informs data on this socket.

◆ pDataReadyCallbackContext

void* CellularSocketContext_t::pDataReadyCallbackContext

Data ready callback context.

◆ openCallback

CellularSocketOpenCallback_t CellularSocketContext_t::openCallback

Informs the socket open status.

◆ pOpenCallbackContext

void* CellularSocketContext_t::pOpenCallbackContext

socket open callback context.

◆ closedCallback

CellularSocketClosedCallback_t CellularSocketContext_t::closedCallback

Informs the socket is closed.

◆ pClosedCallbackContext

void* CellularSocketContext_t::pClosedCallbackContext

socket closed callback context.

◆ pModemData

void* CellularSocketContext_t::pModemData

Modem specific data.

The documentation for this struct was generated from the following file:

cellular_common.h

Data Fields