nl :: Inet :: InetLayer

#include <src/inet/InetLayer.h>

Esto proporciona acceso a servicios de Internet, incluidos temporizadores, resolución del sistema de nombres de dominio (DNS), transporte de red TCP, transporte de red UDP y transporte de red sin procesar, para un solo subproceso.

Resumen

Para BSD / POSIX Sockets, la notificación de preparación de eventos se maneja a través de descriptores de archivo y una implementación tradicional de encuesta / selección en la adaptación de la plataforma.

Para LwIP, la notificación de preparación de eventos se maneja a través de eventos / mensajes y enlaces específicos de la plataforma y del sistema para el sistema de eventos / mensajes.

Constructores y Destructores
`InetLayer (void)` Este es el constructor predeterminado de InetLayer .

Tipos públicos
`@5 { kState_NotInitialized = 0, kState_Initialized = 1, kState_ShutdownInProgress = 2 }`	enumeración El estado actual del objeto InetLayer .
`DNSResolveCompleteFunct`	typedef `DNSResolver::OnResolveCompleteFunct`

Atributos públicos
`State`	`enum nl::Inet::InetLayer::@5` El estado actual del objeto InetLayer .

Atributos estáticos públicos
`sInetEventHandlerDelegate`	`Weave::System::LwIPEventHandlerDelegate`

Funciones publicas
`CanEnqueueDroppableEvent (void)`	`bool`
`CancelResolveHostAddress (DNSResolveCompleteFunct onComplete, void *appState)`	`void` Cancele cualquier consulta de DNS pendiente (para una devolución de llamada de finalización coincidente y el estado de la aplicación) que aún pueda estar activa.
`DroppableEventDequeued (void)`	`void`
`GetInterfaceFromAddr (const IPAddress & addr, InterfaceId & intfId)`	`INET_ERROR` Obtenga el identificador de interfaz para la dirección IP especificada.
`GetLinkLocalAddr (InterfaceId link, IPAddress *llAddr)`	`INET_ERROR` Obtenga la dirección IPv6 local del enlace para un enlace o interfaz especificados.
`GetPlatformData (void)`	`void *` Esto devuelve cualquier dato de plataforma específico del cliente asignado a la instancia, si se ha configurado previamente.
`HandleSelectResult (int selectRes, fd_set readfds, fd_set writefds, fd_set *exceptfds)`	`void` Manejar E / S desde una llamada seleccionada.
`Init ( Weave::System::Layer & aSystemLayer, void *aContext)`	`INET_ERROR` Este es el inicializador explícito de InetLayer .
`InitQueueLimiter (void)`	`INET_ERROR`
`MatchLocalIPv6Subnet (const IPAddress & addr)`	`bool` Compruebe si hay una coincidencia de prefijo entre la dirección IPv6 especificada y cualquiera de las direcciones IPv6 configuradas localmente.
`NewRawEndPoint (IPVersion ipVer, IPProtocol ipProto, RawEndPoint **retEndPoint)`	`INET_ERROR` Crea un nuevo objeto RawEndPoint para una versión y un protocolo de IP específicos.
`NewTCPEndPoint ( TCPEndPoint **retEndPoint)`	`INET_ERROR` Crea un nuevo objeto TCPEndPoint .
`NewTunEndPoint ( TunEndPoint **retEndPoint)`	`INET_ERROR` Crea un nuevo objeto TunEndPoint .
`NewUDPEndPoint ( UDPEndPoint **retEndPoint)`	`INET_ERROR` Crea un nuevo objeto UDPEndPoint .
`PrepareSelect (int & nfds, fd_set readfds, fd_set writefds, fd_set *exceptfds, struct timeval & sleepTime)`	`void` Prepare los conjuntos de descriptores de archivo con los que trabajar con `select()` .
`ResolveHostAddress (const char hostName, uint16_t hostNameLen, uint8_t options, uint8_t maxAddrs, IPAddress addrArray, DNSResolveCompleteFunct onComplete, void *appState)`	`INET_ERROR` Realice una resolución de dirección IP de un nombre de host especificado.
`ResolveHostAddress (const char hostName, uint16_t hostNameLen, uint8_t maxAddrs, IPAddress addrArray, DNSResolveCompleteFunct onComplete, void *appState)`	`INET_ERROR` Realice una resolución de dirección IP de un nombre de host especificado.
`ResolveHostAddress (const char hostName, uint8_t maxAddrs, IPAddress addrArray, DNSResolveCompleteFunct onComplete, void *appState)`	`INET_ERROR` Realice una resolución de dirección IP de un nombre de host especificado.
`SetPlatformData (void *aPlatformData)`	`void` Esto establece los datos de la plataforma específicos del cliente especificados en la instancia para su posterior recuperación por parte de la plataforma del cliente.
`Shutdown (void)`	`INET_ERROR` Este es el desinicializador explícito de InetLayer y se debe llamar antes de eliminar una instancia de InetLayer instanciada.
`SystemLayer (void) const`	`Weave::System::Layer *`

Funciones estáticas públicas
`HandleInetLayerEvent ( Weave::System::Object & aTarget, Weave::System::EventType aEventType, uintptr_t aArgument)`	`Weave::System::Error`
`IsDroppableEvent (Weave::System::EventType aType)`	`bool`
`UpdateSnapshot ( nl::Weave::System::Stats::Snapshot & aSnapshot)`	`void`

Tipos públicos

@ 5

@5

El estado actual del objeto InetLayer .

Propiedades
`kState_Initialized`	Estado inicializado.
`kState_NotInitialized`	Estado no inicializado.
`kState_ShutdownInProgress`	Estado donde se ha activado el apagado.

DNSResolveCompleteFunct

DNSResolver::OnResolveCompleteFunct DNSResolveCompleteFunct

Atributos públicos

Expresar

enum nl::Inet::InetLayer::@5 State

El estado actual del objeto InetLayer .

[SOLO LECTURA] Estado actual.

Atributos estáticos públicos

sInetEventHandlerDelegate

Weave::System::LwIPEventHandlerDelegate sInetEventHandlerDelegate

Funciones publicas

CanEnqueueDroppableEvent

bool CanEnqueueDroppableEvent(
  void
)

CancelarResolverHostAddress

void CancelResolveHostAddress(
  DNSResolveCompleteFunct onComplete,
  void *appState
)

Cancele cualquier consulta de DNS pendiente (para una devolución de llamada de finalización coincidente y el estado de la aplicación) que aún pueda estar activa.

Detalles

Parámetros

`[in] onComplete`	Un puntero a la función de devolución de llamada cuando se completa una solicitud de DNS.
`[in] appState`	Un puntero a un objeto de estado de la aplicación que se pasa a la función de devolución de llamada como argumento.

DroppableEventDequeued

void DroppableEventDequeued(
  void
)

GetInterfaceFromAddr

INET_ERROR GetInterfaceFromAddr(
  const IPAddress & addr,
  InterfaceId & intfId
)

Obtenga el identificador de interfaz para la dirección IP especificada.

Si el identificador de interfaz no se puede derivar, se establece en INET_NULL_INTERFACEID .

Detalles

Parámetros

`[in] addr`	Una referencia al objeto IPAddress .
`[out] intfId`	Una referencia al objeto InterfaceId.

Devoluciones

INET_NO_ERROR incondicionalmente.

GetLinkLocalAddr

INET_ERROR GetLinkLocalAddr(
  InterfaceId link,
  IPAddress *llAddr
)

Obtenga la dirección IPv6 local del enlace para un enlace o interfaz especificados.

Detalles

Parámetros

`[in] link`	La interfaz para la que se busca la dirección IPv6 local del enlace.
`[out] llAddr`	La dirección IPv6 local del enlace para el enlace.

Valores devueltos

`INET_ERROR_NOT_IMPLEMENTED`	Si no se admite IPv6.
`INET_ERROR_BAD_ARGS`	Si la dirección local del enlace es NULL.
`INET_ERROR_ADDRESS_NOT_FOUND`	Si el enlace no tiene ninguna dirección configurada.
`INET_NO_ERROR`	Sobre el éxito.

GetPlatformData

void * GetPlatformData(
  void
)

Esto devuelve cualquier dato de plataforma específico del cliente asignado a la instancia, si se ha configurado previamente.

Detalles
Devoluciones	Datos de plataforma específicos del cliente, si se ha configurado previamente; de lo contrario, NULL.

HandleSelectResult

void HandleSelectResult(
  int selectRes,
  fd_set *readfds,
  fd_set *writefds,
  fd_set *exceptfds
)

Manejar E / S desde una llamada seleccionada.

Este método registra el evento de E / S pendiente en cada punto final activo y luego invoca las funciones de manejo de E / S respectivas para esos puntos finales.

Detalles

Parámetros

`[in] selectRes`	El valor de retorno de la llamada seleccionada.
`[in] readfds`	Un puntero al conjunto de descriptores de archivos leídos.
`[in] writefds`	Un puntero al conjunto de descriptores de archivos de escritura.
`[in] exceptfds`	Un puntero al conjunto de descriptores de archivos con errores.

InetLayer

 InetLayer(
  void
)

Este es el constructor predeterminado de InetLayer .

Realiza una inicialización básica de miembros de datos; sin embargo, dado que InetLayer sigue un patrón de diseño de inicializador explícito, el método InetLayer :: Init debe llamarse correctamente antes de usar el objeto.

En eso

INET_ERROR Init(
  Weave::System::Layer & aSystemLayer,
  void *aContext
)

Este es el inicializador explícito de InetLayer .

Esto se debe llamar y completar correctamente antes de que se pueda usar InetLayer .

La persona que llama puede proporcionar un argumento de contexto opcional que se devolverá a través de cualquier función de enlace específica de la plataforma. Para las adaptaciones basadas en LwIP, normalmente será un puntero a la cola de eventos asociada con la instancia de InetLayer .

Las plataformas pueden optar por afirmar INET_CONFIG_WILL_OVERRIDE_PLATFORM_XTOR_FUNCS en su encabezado de configuración específica de la plataforma y habilitar los enlaces Platform :: InetLayer :: WillInit y Platform :: InetLayer :: DidInit para realizar personalizaciones específicas de la plataforma o extensiones de datos para InetLayer .

Detalles

Parámetros

`[in] aSystemLayer`	Una instancia requerida de la capa del sistema de tejido ya se ha inicializado correctamente.
`[in] aContext`	Un argumento de contexto opcional que se devolverá a la persona que llama a través de cualquier función de enlace específica de la plataforma.

Valores devueltos

`INET_ERROR_INCORRECT_STATE`	Si InetLayer está en un estado incorrecto.
`INET_ERROR_NO_MEMORY`	Si InetLayer se queda sin recursos para esta solicitud de un nuevo temporizador.
`other`	Errores específicos de la plataforma que indican el motivo del error de inicialización.
`INET_NO_ERROR`	Sobre el éxito.

InitQueueLimiter

INET_ERROR InitQueueLimiter(
  void
)

MatchLocalIPv6Subnet

bool MatchLocalIPv6Subnet(
  const IPAddress & addr
)

Compruebe si hay una coincidencia de prefijo entre la dirección IPv6 especificada y cualquiera de las direcciones IPv6 configuradas localmente.

Detalles

Parámetros

[in] addr

La dirección IPv6 para verificar la coincidencia de prefijo.

Devoluciones

Es verdadero si se encuentra una coincidencia exitosa; de lo contrario, es falso.

NewRawEndPoint

INET_ERROR NewRawEndPoint(
  IPVersion ipVer,
  IPProtocol ipProto,
  RawEndPoint **retEndPoint
)

Crea un nuevo objeto RawEndPoint para una versión y un protocolo de IP específicos.

Detalles

Parámetros

`[in] ipVer`	IPv4 o IPv6.
`[in] ipProto`	Un protocolo dentro de la familia de IP (p. Ej., ICMPv4 o ICMPv6).
`[in,out] retEndPoint`	Un puntero a un puntero del objeto RawEndPoint que es un parámetro de retorno al finalizar la creación del objeto. * retEndPoint es NULL si falla la creación.

Valores devueltos

`INET_ERROR_INCORRECT_STATE`	Si el objeto InetLayer no está inicializado.
`INET_ERROR_NO_ENDPOINTS`	Si el grupo InetLayer RawEndPoint está lleno y no se pueden crear nuevos puntos finales.
`INET_NO_ERROR`	Sobre el éxito.

NewTCPEndPoint

INET_ERROR NewTCPEndPoint(
  TCPEndPoint **retEndPoint
)

Crea un nuevo objeto TCPEndPoint .

Detalles

Parámetros

[in,out] retEndPoint

Un puntero a un puntero del objeto TCPEndPoint que es un parámetro de retorno al finalizar la creación del objeto. * retEndPoint es NULL si falla la creación.

Valores devueltos

`INET_ERROR_INCORRECT_STATE`	Si el objeto InetLayer no está inicializado.
`INET_ERROR_NO_ENDPOINTS`	Si el grupo InetLayer TCPEndPoint está lleno y no se pueden crear nuevos puntos finales.
`INET_NO_ERROR`	Sobre el éxito.

NewTunEndPoint

INET_ERROR NewTunEndPoint(
  TunEndPoint **retEndPoint
)

Crea un nuevo objeto TunEndPoint .

Detalles

Parámetros

[in,out] retEndPoint

Un puntero a un puntero del objeto TunEndPoint que es un parámetro de retorno al finalizar la creación del objeto. * retEndPoint es NULL si falla la creación.

Valores devueltos

`INET_ERROR_INCORRECT_STATE`	Si el objeto InetLayer no está inicializado.
`INET_ERROR_NO_ENDPOINTS`	Si el grupo InetLayer TunEndPoint está lleno y no se pueden crear nuevos.
`INET_NO_ERROR`	Sobre el éxito.

NewUDPEndPoint

INET_ERROR NewUDPEndPoint(
  UDPEndPoint **retEndPoint
)

Crea un nuevo objeto UDPEndPoint .

Detalles

Parámetros

[in,out] retEndPoint

Un puntero a un puntero del objeto UDPEndPoint que es un parámetro de retorno al finalizar la creación del objeto. * retEndPoint es NULL si falla la creación.

Valores devueltos

`INET_ERROR_INCORRECT_STATE`	Si el objeto InetLayer no está inicializado.
`INET_ERROR_NO_ENDPOINTS`	Si el grupo InetLayer UDPEndPoint está lleno y no se pueden crear nuevos puntos finales.
`INET_NO_ERROR`	Sobre el éxito.

PrepararSeleccionar

void PrepareSelect(
  int & nfds,
  fd_set *readfds,
  fd_set *writefds,
  fd_set *exceptfds,
  struct timeval & sleepTime
)

Prepare los conjuntos de descriptores de archivo con los que trabajar con select() .

Detalles

Parámetros

`[out] nfds`	El rango de descriptores de archivo en el conjunto de descriptores de archivo.
`[in] readfds`	Un puntero al conjunto de descriptores de archivos legibles.
`[in] writefds`	Un puntero al conjunto de descriptores de archivos grabables.
`[in] exceptfds`	Un puntero al conjunto de descriptores de archivos con errores.
`[in] sleepTimeTV`	Un puntero a una estructura que especifica cuánto tiempo debe dormir la selección.

ResolveHostAddress

INET_ERROR ResolveHostAddress(
  const char *hostName,
  uint16_t hostNameLen,
  uint8_t options,
  uint8_t maxAddrs,
  IPAddress *addrArray,
  DNSResolveCompleteFunct onComplete,
  void *appState
)

Realice una resolución de dirección IP de un nombre de host especificado.

Detalles

Parámetros

`[in] hostName`	Un puntero a una cadena C no terminada en NULL que representa el nombre de host que se va a consultar.
`[in] hostNameLen`	La longitud de la cadena del nombre de host.
`[in] options`	Un valor entero que controla cómo se realiza la resolución de nombres de host. Value should be one of the address family values from the #DNSOptions enumeration: #kDNSOption_AddrFamily_Any #kDNSOption_AddrFamily_IPv4Only #kDNSOption_AddrFamily_IPv6Only #kDNSOption_AddrFamily_IPv4Preferred #kDNSOption_AddrFamily_IPv6Preferred
`[in] maxAddrs`	El número máximo de direcciones para almacenar en la tabla DNS.
`[in] addrArray`	Un puntero a la tabla DNS.
`[in] onComplete`	Un puntero a la función de devolución de llamada cuando se completa una solicitud de DNS.
`[in] appState`	Un puntero al estado de la aplicación que se pasará a onComplete cuando se complete una solicitud de DNS.

Valores devueltos

`INET_NO_ERROR`	si una solicitud de DNS se maneja con éxito.
`INET_ERROR_NO_MEMORY`	si el grupo de resolución de la capa Inet está lleno.
`INET_ERROR_HOST_NAME_TOO_LONG`	si un nombre de host solicitado es demasiado largo.
`INET_ERROR_HOST_NOT_FOUND`	si un nombre de host de solicitud no se pudo resolver en una dirección.
`INET_ERROR_DNS_TRY_AGAIN`	si un servidor de nombres devolvió una indicación de falla temporal; inténtalo de nuevo más tarde.
`INET_ERROR_DNS_NO_RECOVERY`	si un servidor de nombres devolvió un error irrecuperable.
`INET_ERROR_NOT_IMPLEMENTED`	si la resolución de DNS no está habilitada en la plataforma subyacente.
`other`	Error de sistema operativo o red POSIX devuelto por la implementación de resolución de DNS subyacente.

ResolveHostAddress

INET_ERROR ResolveHostAddress(
  const char *hostName,
  uint16_t hostNameLen,
  uint8_t maxAddrs,
  IPAddress *addrArray,
  DNSResolveCompleteFunct onComplete,
  void *appState
)

Realice una resolución de dirección IP de un nombre de host especificado.

Detalles

Parámetros

`[in] hostName`	Un puntero a una cadena C no terminada en NULL que representa el nombre de host que se va a consultar.
`[in] hostNameLen`	La longitud de la cadena del nombre de host.
`[in] maxAddrs`	El número máximo de direcciones para almacenar en la tabla DNS.
`[in] addrArray`	Un puntero a la tabla DNS.
`[in] onComplete`	Un puntero a la función de devolución de llamada cuando se completa una solicitud de DNS.
`[in] appState`	Un puntero al estado de la aplicación que se pasará a onComplete cuando se complete una solicitud de DNS.

Valores devueltos

`INET_NO_ERROR`	si una solicitud de DNS se maneja con éxito.
`INET_ERROR_NO_MEMORY`	si el grupo de resolución de la capa Inet está lleno.
`INET_ERROR_HOST_NAME_TOO_LONG`	si un nombre de host solicitado es demasiado largo.
`INET_ERROR_HOST_NOT_FOUND`	si un nombre de host de solicitud no se pudo resolver en una dirección.
`INET_ERROR_DNS_TRY_AGAIN`	si un servidor de nombres devolvió una indicación de falla temporal; inténtalo de nuevo más tarde.
`INET_ERROR_DNS_NO_RECOVERY`	si un servidor de nombres devolvió un error irrecuperable.
`INET_ERROR_NOT_IMPLEMENTED`	si la resolución de DNS no está habilitada en la plataforma subyacente.
`other`	Error de sistema operativo o red POSIX devuelto por la implementación de resolución de DNS subyacente.

ResolveHostAddress

INET_ERROR ResolveHostAddress(
  const char *hostName,
  uint8_t maxAddrs,
  IPAddress *addrArray,
  DNSResolveCompleteFunct onComplete,
  void *appState
)

Realice una resolución de dirección IP de un nombre de host especificado.

Detalles

Parámetros

`[in] hostName`	Un puntero a una cadena C terminada en NULL que representa el nombre de host que se va a consultar.
`[in] maxAddrs`	El número máximo de direcciones para almacenar en la tabla DNS.
`[in] addrArray`	Un puntero a la tabla DNS.
`[in] onComplete`	Un puntero a la función de devolución de llamada cuando se completa una solicitud de DNS.
`[in] appState`	Un puntero al estado de la aplicación que se pasará a onComplete cuando se complete una solicitud de DNS.

Valores devueltos

`INET_NO_ERROR`	si una solicitud de DNS se maneja con éxito.
`INET_ERROR_NO_MEMORY`	si el grupo de resolución de la capa Inet está lleno.
`INET_ERROR_HOST_NAME_TOO_LONG`	si un nombre de host solicitado es demasiado largo.
`INET_ERROR_HOST_NOT_FOUND`	si un nombre de host de solicitud no se pudo resolver en una dirección.
`INET_ERROR_DNS_TRY_AGAIN`	si un servidor de nombres devolvió una indicación de falla temporal; inténtalo de nuevo más tarde.
`INET_ERROR_DNS_NO_RECOVERY`	si un servidor de nombres devolvió un error irrecuperable.
`INET_ERROR_NOT_IMPLEMENTED`	si la resolución de DNS no está habilitada en la plataforma subyacente.
`other`	Error de sistema operativo o red POSIX devuelto por la implementación de resolución de DNS subyacente.

SetPlatformData

void SetPlatformData(
  void *aPlatformData
)

Esto establece los datos de la plataforma específicos del cliente especificados en la instancia para su posterior recuperación por parte de la plataforma del cliente.

Detalles

Parámetros

[in] aPlatformData

Los datos de la plataforma específicos del cliente que se van a configurar.

Cerrar

INET_ERROR Shutdown(
  void
)

Este es el desinicializador explícito de InetLayer y se debe llamar antes de eliminar una instancia de InetLayer instanciada.

Las plataformas pueden optar por afirmar INET_CONFIG_WILL_OVERRIDE_PLATFORM_XTOR_FUNCS en su encabezado de configuración específica de plataforma y habilitar los enlaces Platform :: InetLayer :: WillShutdown y Platform :: InetLayer :: DidShutdown para efectuar la limpieza de personalizaciones específicas de la plataforma o extensiones de datos en InetLayer .

Detalles
Devoluciones	INET_NO_ERROR en caso de éxito; de lo contrario, un error específico que indica el motivo de la falla de apagado.

SystemLayer

Weave::System::Layer * SystemLayer(
  void
) const

Funciones estáticas públicas

HandleInetLayerEvent

Weave::System::Error HandleInetLayerEvent(
  Weave::System::Object & aTarget,
  Weave::System::EventType aEventType,
  uintptr_t aArgument
)

IsDroppableEvent

bool IsDroppableEvent(
  Weave::System::EventType aType
)

UpdateSnapshot

void UpdateSnapshot(
  nl::Weave::System::Stats::Snapshot & aSnapshot
)

nl :: Inet :: InetLayer

Resumen

Constructores y Destructores

Tipos públicos

Atributos públicos

Atributos estáticos públicos

Funciones publicas

Funciones estáticas públicas

Tipos públicos

@ 5

DNSResolveCompleteFunct

Atributos públicos

Expresar

Atributos estáticos públicos

sInetEventHandlerDelegate

Funciones publicas

CanEnqueueDroppableEvent

CancelarResolverHostAddress

DroppableEventDequeued

GetInterfaceFromAddr

GetLinkLocalAddr

GetPlatformData

HandleSelectResult

InetLayer

En eso

InitQueueLimiter

MatchLocalIPv6Subnet

NewRawEndPoint

NewTCPEndPoint

NewTunEndPoint

NewUDPEndPoint

PrepararSeleccionar

ResolveHostAddress

ResolveHostAddress

ResolveHostAddress

SetPlatformData

Cerrar

SystemLayer

Funciones estáticas públicas

HandleInetLayerEvent

IsDroppableEvent

UpdateSnapshot