nl :: Inet :: IPEndPointBasis

#include <src/inet/IPEndPointBasis.h>

Los objetos de esta clase representan puntos finales de protocolo IP de los que no se pueden crear instancias.

Resumen

Herencia

Hereda de: nl :: Inet :: EndPointBasis
Subclases conocidas directas:
nl :: Inet :: RawEndPoint
nl :: Inet :: UDPEndPoint

Tipos públicos
`@8 { kState_Ready = kBasisState_Closed, kState_Bound = 1, kState_Listening = 2, kState_Closed = 3 }`	enumeración Estado dinámico básico del punto final subyacente.
`@9 { kSendFlag_RetainBuffer = 0x0040 }`	enumeración Transmitir indicadores de opción para el método `SendMsg` .
`OnMessageReceivedFunct )(IPEndPointBasis endPoint, Weave::System::PacketBuffer msg, const IPPacketInfo *pktInfo)`	typedef `void(*` Tipo de función de manejo de eventos de recepción de texto de mensaje.
`OnReceiveErrorFunct )(IPEndPointBasis endPoint, INET_ERROR err, const IPPacketInfo pktInfo)`	typedef `void(*` Tipo de función de manejo de eventos de error de recepción.

Atributos públicos
`OnMessageReceived`	`OnMessageReceivedFunct` Delegado de la función de manejo de eventos de recepción de mensajes del punto final.
`OnReceiveError`	`OnReceiveErrorFunct` Delegado de función de manejo de eventos de error de recepción del punto final.
`mState`	`enum nl::Inet::IPEndPointBasis::@8` Estado dinámico básico del punto final subyacente.

Atributos protegidos
`mBoundIntfId`	`InterfaceId`

Funciones publicas
`JoinMulticastGroup (InterfaceId aInterfaceId, const IPAddress & aAddress)`	`INET_ERROR` Únase a un grupo de multidifusión IP.
`LeaveMulticastGroup (InterfaceId aInterfaceId, const IPAddress & aAddress)`	`INET_ERROR` Deje un grupo de multidifusión de IP.
`SetMulticastLoopback (IPVersion aIPVersion, bool aLoopback)`	`INET_ERROR` Establezca si el tráfico de multidifusión IP debe retroceder.

Funciones protegidas
`Bind (IPAddressType aAddressType, IPAddress aAddress, uint16_t aPort, InterfaceId aInterfaceId)`	`INET_ERROR`
`BindInterface (IPAddressType aAddressType, InterfaceId aInterfaceId)`	`INET_ERROR`
`GetSocket (IPAddressType aAddressType, int aType, int aProtocol)`	`INET_ERROR`
`HandleDataReceived ( Weave::System::PacketBuffer *aBuffer)`	`void`
`HandlePendingIO (uint16_t aPort)`	`void`
`Init ( InetLayer *aInetLayer)`	`void`
`PrepareIO (void)`	`SocketEvents`
`SendMsg (const IPPacketInfo aPktInfo, Weave::System::PacketBuffer aBuffer, uint16_t aSendFlags)`	`INET_ERROR`

Funciones estáticas públicas
`FindNetifFromInterfaceId (InterfaceId aInterfaceId)`	`struct netif *`

Funciones estáticas protegidas
`GetPacketInfo ( Weave::System::PacketBuffer *buf)`	`IPPacketInfo *` Obtenga información de direccionamiento de origen y destino de la capa IP de LwIP.

Tipos públicos

@ 8

@8

Estado dinámico básico del punto final subyacente.

Los objetos se inicializan en el estado "listo", pasan al estado "vinculado" después de vincularse a una dirección de interfaz local, luego pasan al estado "escuchando" cuando tienen continuaciones registradas para manejar eventos para la recepción de mensajes ICMP.

Nota: La kBasisState_Closed estado kBasisState_Closed se asigna a kState_Ready por kState_Ready históricas de compatibilidad binaria. El kState_Closed existente existe para identificar por separado la distinción entre "no abierto todavía" y "abierto anteriormente ahora cerrado" que existía anteriormente en los estados kState_Ready y kState_Closed .

Propiedades
`kState_Bound`	Punto final vinculado, pero no escucha.
`kState_Closed`	Punto final cerrado, listo para su lanzamiento.
`kState_Listening`	Datagramas de recepción de punto final.
`kState_Ready`	Punto final inicializado, pero no abierto.

@ 9

@9

Transmitir indicadores de opción para el método SendMsg .

Propiedades

Propiedades
`kSendFlag_RetainBuffer`	No pongas el mensaje en cola de forma destructiva directamente. Ponga una copia en cola.

kSendFlag_RetainBuffer

No pongas el mensaje en cola de forma destructiva directamente.

Ponga una copia en cola.

OnMessageReceivedFunct

void(* OnMessageReceivedFunct)(IPEndPointBasis *endPoint, Weave::System::PacketBuffer *msg, const IPPacketInfo *pktInfo)

Tipo de función de manejo de eventos de recepción de texto de mensaje.

Proporcione una función de este tipo al miembro delegado OnMessageReceived para procesar eventos de recepción de texto de mensaje en endPoint donde msg es el texto del mensaje recibido del remitente en senderAddr .

Detalles

Parámetros

`[in] endPoint`	El punto final asociado con el evento.
`[in] msg`	El mensaje de texto recibido.
`[in] senderAddr`	La dirección IP del remitente.

OnReceiveErrorFunct

void(* OnReceiveErrorFunct)(IPEndPointBasis *endPoint, INET_ERROR err, const IPPacketInfo *pktInfo)

Tipo de función de manejo de eventos de error de recepción.

Proporcione una función de este tipo al miembro delegado OnReceiveError para procesar eventos de error de recepción en endPoint . El argumento err proporciona detalles específicos sobre el tipo de error.

Detalles

Parámetros

`[in] endPoint`	El punto final asociado con el evento.
`[in] err`	El motivo del error.

Atributos públicos

OnMessageReceived

OnMessageReceivedFunct OnMessageReceived

Delegado de la función de manejo de eventos de recepción de mensajes del punto final.

OnReceiveError

OnReceiveErrorFunct OnReceiveError

Delegado de función de manejo de eventos de error de recepción del punto final.

mState

enum nl::Inet::IPEndPointBasis::@8 mState

Estado dinámico básico del punto final subyacente.

Atributos protegidos

mBoundIntfId

InterfaceId mBoundIntfId

Funciones publicas

JoinMulticastGroup

INET_ERROR JoinMulticastGroup(
  InterfaceId aInterfaceId,
  const IPAddress & aAddress
)

Únase a un grupo de multidifusión IP.

Únase al punto final al grupo de multidifusión proporcionado en la interfaz especificada.

Detalles

Parámetros

`[in] aInterfaceId`	el indicador de la interfaz de red para agregar al grupo de multidifusión
`[in] aAddress`	el grupo de multidifusión para agregar la interfaz al

Valores devueltos

`INET_NO_ERROR`	éxito: grupo de multidifusión eliminado
`INET_ERROR_UNKNOWN_INTERFACE`	interfaz de red desconocida, `aInterfaceId`
`INET_ERROR_WRONG_ADDRESS_TYPE`	`aAddress` no es `kIPAddressType_IPv4` o `kIPAddressType_IPv6` o no es multidifusión
`other`	otro error de sistema o plataforma

LeaveMulticastGroup

INET_ERROR LeaveMulticastGroup(
  InterfaceId aInterfaceId,
  const IPAddress & aAddress
)

Deje un grupo de multidifusión de IP.

Elimine el extremo del grupo de multidifusión proporcionado en la interfaz especificada.

Detalles

Parámetros

`[in] aInterfaceId`	el indicador de la interfaz de red para eliminar del grupo de multidifusión
`[in] aAddress`	el grupo de multidifusión para eliminar la interfaz de

Valores devueltos

`INET_NO_ERROR`	éxito: grupo de multidifusión eliminado
`INET_ERROR_UNKNOWN_INTERFACE`	interfaz de red desconocida, `aInterfaceId`
`INET_ERROR_WRONG_ADDRESS_TYPE`	`aAddress` no es `kIPAddressType_IPv4` o `kIPAddressType_IPv6` o no es multidifusión
`other`	otro error de sistema o plataforma

SetMulticastLoopback

INET_ERROR SetMulticastLoopback(
  IPVersion aIPVersion,
  bool aLoopback
)

Establezca si el tráfico de multidifusión IP debe retroceder.

Establezca si el tráfico de multidifusión IP debe volver a este punto final.

Detalles

Parámetros

`[in] aIPVersion`
`[in] aLoop`

Valores devueltos

`INET_NO_ERROR`	éxito: conjunto de comportamiento de bucle invertido de multidifusión
`other`	otro error de sistema o plataforma

Funciones protegidas

Unir

INET_ERROR Bind(
  IPAddressType aAddressType,
  IPAddress aAddress,
  uint16_t aPort,
  InterfaceId aInterfaceId
)

BindInterface

INET_ERROR BindInterface(
  IPAddressType aAddressType,
  InterfaceId aInterfaceId
)

GetSocket

INET_ERROR GetSocket(
  IPAddressType aAddressType,
  int aType,
  int aProtocol
)

HandleDataReceived

void HandleDataReceived(
  Weave::System::PacketBuffer *aBuffer
)

HandlePendingIO

void HandlePendingIO(
  uint16_t aPort
)

En eso

void Init(
  InetLayer *aInetLayer
)

PrepareIO

SocketEvents PrepareIO(
  void
)

SendMsg

INET_ERROR SendMsg(
  const IPPacketInfo *aPktInfo,
  Weave::System::PacketBuffer *aBuffer,
  uint16_t aSendFlags
)

Funciones estáticas públicas

FindNetifFromInterfaceId

struct netif * FindNetifFromInterfaceId(
  InterfaceId aInterfaceId
)

Funciones estáticas protegidas

GetPacketInfo

IPPacketInfo * GetPacketInfo(
  Weave::System::PacketBuffer *buf
)

Obtenga información de direccionamiento de origen y destino de la capa IP de LwIP.

Cuando se usa LwIP, la información sobre el paquete está 'oculta' en el espacio reservado antes del inicio de los datos en el búfer de paquetes. Esto es necesario porque los eventos de la capa del sistema solo tienen dos argumentos, que en este caso se utilizan para transportar el puntero al punto final y el puntero al búfer.

Detalles

Parámetros

[in] aBuffer

el búfer de paquetes que contiene el mensaje IP

Devoluciones

un puntero a la información de la dirección sobre el éxito; de lo contrario, NULL si no hay suficiente espacio en el paquete para la información de la dirección.

En la mayoría de los casos, este truco de almacenar información antes de que los datos funcione porque el primer búfer en un mensaje IP LwIP contiene el espacio que se usó para los encabezados Ethernet / IP / UDP. Sin embargo, dado el tamaño actual de la estructura IPPacketInfo (40 bytes), es posible que no haya suficiente espacio para almacenar la estructura junto con la carga útil en un solo búfer de paquete. En la práctica, esto solo debería suceder para paquetes IPv4 extremadamente grandes que llegan sin un encabezado Ethernet.