nl::Inet::EndPointBasis

#include <src/inet/EndPointBasis.h>

Basis of internet transport endpoint classes.

Summary

Inheritance

Inherits from: nl::Inet::InetLayerBasis
Direct Known Subclasses:
  nl::Inet::IPEndPointBasis
  nl::Inet::TCPEndPoint
  nl::Inet::TunEndPoint

Public types

@0{
  kBasisState_Closed = 0
}
enum
Common state codes.

Protected types

@3 enum

Protected attributes

@2
union nl::Inet::EndPointBasis::@1
Encapsulated LwIP protocol control block.
mAddrType
IPAddressType
Protocol family, i.e.
mLwIPEndPointType
uint8_t
mPendingIO
Socket event masks.
mSocket
int
Encapsulated socket descriptor.

Public attributes

mNetIf
netif *
Tunnel interface control.
mRaw
raw_pcb *
Raw network interface protocol control.
mTCP
tcp_pcb *
Transmission control protocol (TCP) control.
mUDP
udp_pcb *
User datagram protocol (UDP) control.
mVoid
const void *
An untyped protocol control buffer reference.

Public functions

IsLWIPEndPoint(void) const
bool
Test whether endpoint is a LwIP protocol control buffer.
IsOpenEndPoint(void) const
bool
Test whether endpoint has a valid descriptor.
IsSocketsEndPoint(void) const
bool
Test whether endpoint is a POSIX socket.

Protected functions

DeferredFree(Weave::System::Object::ReleaseDeferralErrorTactic aTactic)
void
InitEndPointBasis(InetLayer & aInetLayer, void *aAppState)
void

Public types

@0

 @0

Common state codes.

Properties
kBasisState_Closed

Encapsulated descriptor is not valid.

Protected types

@3

 @3

Protected attributes

@2

union nl::Inet::EndPointBasis::@1 @2

Encapsulated LwIP protocol control block.

mAddrType

IPAddressType mAddrType

Protocol family, i.e.

IPv4 or IPv6.

mLwIPEndPointType

uint8_t mLwIPEndPointType

mPendingIO

SocketEvents mPendingIO

Socket event masks.

mSocket

int mSocket

Encapsulated socket descriptor.

Public attributes

mNetIf

netif * mNetIf

Tunnel interface control.

mRaw

raw_pcb * mRaw

Raw network interface protocol control.

mTCP

tcp_pcb * mTCP

Transmission control protocol (TCP) control.

mUDP

udp_pcb * mUDP

User datagram protocol (UDP) control.

mVoid

const void * mVoid

An untyped protocol control buffer reference.

Public functions

IsLWIPEndPoint

bool IsLWIPEndPoint(
  void
) const 

Test whether endpoint is a LwIP protocol control buffer.

IsOpenEndPoint

bool IsOpenEndPoint(
  void
) const 

Test whether endpoint has a valid descriptor.

IsSocketsEndPoint

bool IsSocketsEndPoint(
  void
) const 

Test whether endpoint is a POSIX socket.

Protected functions

DeferredFree

void DeferredFree(
  Weave::System::Object::ReleaseDeferralErrorTactic aTactic
)

InitEndPointBasis

void InitEndPointBasis(
  InetLayer & aInetLayer,
  void *aAppState
)