nl::Weave::WeaveMessageLayer

#include <src/lib/core/WeaveMessageLayer.h>

Es la definición de la clase WeaveMessageLayer, que administra la comunicación con otros nodos de Weave.

Resumen

Utiliza uno de los diversos extremos de InetLayer para establecer un canal de comunicación con otros nodos de Weave.

Constructores y destructores
WeaveMessageLayer(void)
Constructor de capas de mensajes de Weave.

Tipos públicos
AcceptErrorFunct)(WeaveMessageLayer *msgLayer, WEAVE_ERROR err) typedef
void(*
Esta función es la devolución de llamada de capa superior para informar un error durante el manejo de una conexión TCP entrante.
CallbackRemovedFunct)(void *listenerState) typedef
void(*
Esta función se invoca para quitar una devolución de llamada.
ConnectionReceiveFunct)(WeaveMessageLayer *msgLayer, WeaveConnection *con) typedef
void(*
Esta función es la devolución de llamada de capa superior para controlar una conexión TCP entrante.
MessageLayerActivityChangeHandlerFunct)(bool messageLayerIsActive) typedef
void(*
Esta función es la devolución de llamada de la aplicación para informar sobre el cambio de actividad en la capa de mensajes.
MessageReceiveFunct)(WeaveMessageLayer *msgLayer, WeaveMessageInfo *msgInfo, PacketBuffer *payload) typedef
void(*
Esta función es la devolución de llamada de capa superior que se invoca cuando se recibe un mensaje de Weave mediante UDP.
ReceiveErrorFunct)(WeaveMessageLayer *msgLayer, WEAVE_ERROR err, const IPPacketInfo *pktInfo) typedef
void(*
Esta función es la devolución de llamada de capa superior que se invoca cuando se encuentra un error.
State{
  kState_NotInitialized = 0,
  kState_Initializing = 1,
  kState_Initialized = 2
} 		enum
El estado de WeaveMessageLayer.
TunneledMsgReceiveFunct)(WeaveMessageLayer *msgLayer, PacketBuffer *payload) typedef
void(*
Esta función es la devolución de llamada de capa superior que se invoca cuando se recibe un paquete túnel a través de un túnel UDP local.

Atributos públicos
AppState
void *
Un puntero para un objeto de estado específico de la aplicación.
ExchangeMgr
[SOLO LECTURA] El objeto asociado WeaveExchangeManager.
FabricState
[READ ONLY] El objeto asociado WeaveFabricState
IncomingConIdleTimeout
uint32_t
Tiempo de espera de inactividad predeterminado (en milisegundos) para las conexiones entrantes.
Inet
InetLayer *
[SOLO LECTURA] El objeto InetLayer asociado.
IsListening
bool
[SOLO LECTURA] Verdadero si detecta conexiones o mensajes entrantes; de lo contrario, es falso.
OnAcceptError
OnConnectionReceived
OnMessageReceived
OnReceiveError
OnUDPTunneledMessageReceived
SecurityMgr
[READ ONLY] El objeto asociado WeaveSecurityManager.
State
uint8_t
[READ ONLY] El estado del objeto WeaveMessageLayer.
SystemLayer
mDropMessage
bool
Interno y solo para depuración. Cuando se configura, WeaveMessageLayer descarta el mensaje y muestra resultados.

Funciones públicas
ClearUnsecuredConnectionListener(ConnectionReceiveFunct oldOnUnsecuredConnectionReceived, CallbackRemovedFunct newOnUnsecuredConnectionCallbacksRemoved)
CloseEndpoints(void)
Cierra todos los extremos TCP y UDP abiertos.
CreateTunnel(WeaveConnectionTunnel **tunPtr, WeaveConnection & conOne, WeaveConnection & conTwo, uint32_t inactivityTimeoutMS)
Crea un WeaveConnectionTunnel. Para ello, acopla dos WeaveConnections especificadas.
DecodeHeader(PacketBuffer *msgBuf, WeaveMessageInfo *msgInfo, uint8_t **payloadStart)
Decodifica un encabezado de la capa de mensajes de Weave de un mensaje de Weave recibido.
EncodeMessage(WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf, WeaveConnection *con, uint16_t maxLen, uint16_t reserve)
Codifica un encabezado WeaveMessageLayer en un PacketBuffer.
EncodeMessage(const IPAddress & destAddr, uint16_t destPort, InterfaceId sendIntId, WeaveMessageInfo *msgInfo, PacketBuffer *payload)
Codifica un encabezado de la capa de mensajes de Weave en un PacketBuffer.
EphemeralUDPPortEnabled(void) const
bool
Verifica si los intercambios UDP de Weave iniciados localmente deben enviarse desde un puerto de origen UDP efímero.
GetConnectionPoolStats(nl::Weave::System::Stats::count_t & aOutInUse) const
void
Obtén la cantidad de WeaveConnections en uso y el tamaño del grupo.
IPv4ListenEnabled(void) const
bool
Verifica si WeaveMessageLayer está configurado para escuchar las comunicaciones entrantes a través de IPv4.
IPv6ListenEnabled(void) const
bool
Verifica si WeaveMessageLayer está configurado para escuchar las comunicaciones entrantes a través de IPv4.
Init(InitContext *context)
Inicializa el objeto de la capa de mensaje de Weave.
IsBoundToLocalIPv4Address(void) const
bool
Verifica si WeaveMessageLayer está vinculada a una dirección IPv4 local.
IsBoundToLocalIPv6Address(void) const
bool
Verifica si WeaveMessageLayer está vinculada a una dirección IPv6 local.
IsMessageLayerActive(void)
bool
NewConnection(void)
Crea un objeto WeaveConnection nuevo desde un grupo.
NewConnectionTunnel(void)
Crea un objeto WeaveConnectionTunnel nuevo desde un grupo.
ReEncodeMessage(PacketBuffer *buf)
RefreshEndpoints(void)
Actualiza los extremos de InetLayer en función del estado actual de las interfaces de red del sistema.
ResendMessage(WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Vuelve a enviar un mensaje codificado de Weave mediante el extremo UDP de Inetlayer subyacente.
ResendMessage(const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Vuelve a enviar un mensaje codificado de Weave mediante el extremo UDP de Inetlayer subyacente.
ResendMessage(const IPAddress & destAddr, uint16_t destPort, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Vuelve a enviar un mensaje codificado de Weave mediante el extremo UDP de Inetlayer subyacente.
ResendMessage(const IPAddress & destAddr, uint16_t destPort, InterfaceId interfaceId, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Vuelve a enviar un mensaje codificado de Weave mediante el extremo UDP de Inetlayer subyacente.
SendMessage(WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Envía un mensaje de Weave mediante el extremo UDP de Inetlayer subyacente después de codificarlo.
SendMessage(const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Envía un mensaje de Weave mediante el extremo UDP de Inetlayer subyacente después de codificarlo.
SendMessage(const IPAddress & destAddr, uint16_t destPort, InterfaceId sendIntfId, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Envía un mensaje de Weave mediante el extremo UDP de Inetlayer subyacente después de codificarlo.
SendUDPTunneledMessage(const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Es la función para enviar un paquete túnel a través de un túnel UDP local.
SetSignalMessageLayerActivityChanged(MessageLayerActivityChangeHandlerFunct messageLayerActivityChangeHandler)
void
Configura un controlador de aplicaciones al que se llamará cada vez que cambie la actividad de la capa de mensajes.
SetTCPListenEnabled(bool val)
void
Habilita o inhabilita la detección de conexiones TCP entrantes en WeaveMessageLayer.
SetUDPListenEnabled(bool val)
void
Habilita o inhabilita la detección de mensajes UDP entrantes en WeaveMessageLayer.
SetUnsecuredConnectionListener(ConnectionReceiveFunct newOnUnsecuredConnectionReceived, CallbackRemovedFunct newOnUnsecuredConnectionCallbacksRemoved, bool force, void *listenerState)
Shutdown(void)
TCPListenEnabled(void) const
bool
Verifica si WeaveMessageLayer está configurado para escuchar las conexiones TCP entrantes.
UDPListenEnabled(void) const
bool
Verifica si WeaveMessageLayer está configurado para escuchar mensajes UDP entrantes.
UnsecuredListenEnabled(void) const
bool
Habilita o inhabilita el inicio de los intercambios UDP de Weave desde un puerto de origen UDP efímero.

Funciones estáticas públicas
GetMaxWeavePayloadSize(const PacketBuffer *msgBuf, bool isUDP, uint32_t udpMTU)
uint32_t
Obtener el tamaño máximo de carga útil de Weave para una configuración de mensaje y el PacketBuffer suministrado.
GetPeerDescription(char *buf, size_t bufSize, uint64_t nodeId, const IPAddress *addr, uint16_t port, InterfaceId interfaceId, const WeaveConnection *con)
void
Construye una cadena que describe un nodo par y su dirección / información de conexión asociada.
GetPeerDescription(char *buf, size_t bufSize, const WeaveMessageInfo *msgInfo)
void
Construye una cadena que describe un nodo de intercambio de tráfico en función de la información asociada con un mensaje recibido del par.

Clases
nl::Weave::WeaveMessageLayer::InitContext

Es la definición de la clase InitContext.

Tipos públicos

AcceptErrorFunct

void(* AcceptErrorFunct)(WeaveMessageLayer *msgLayer, WEAVE_ERROR err)

Esta función es la devolución de llamada de capa superior para informar un error durante el manejo de una conexión TCP entrante.

Detalles
Parámetros
[in] msgLayer
Un puntero para el objeto WeaveMessageLayer.
[in] err
Se encontró el WEAVE_ERROR cuando se controlaba una conexión TCP entrante.

CallbackRemovedFunct

void(* CallbackRemovedFunct)(void *listenerState)

Esta función se invoca para quitar una devolución de llamada.

Detalles
Parámetros
[in] listenerState
Un puntero al objeto de estado de la aplicación.

ConnectionReceiveFunct

void(* ConnectionReceiveFunct)(WeaveMessageLayer *msgLayer, WeaveConnection *con)

Esta función es la devolución de llamada de capa superior para controlar una conexión TCP entrante.

Detalles
Parámetros
[in] msgLayer
Un puntero para el objeto WeaveMessageLayer.
[in] con
Un puntero para el objeto WeaveConnection.

MessageLayerActivityChangeHandlerFunct

void(* MessageLayerActivityChangeHandlerFunct)(bool messageLayerIsActive)

Esta función es la devolución de llamada de la aplicación para informar sobre el cambio de actividad en la capa de mensajes.

La capa de mensajes se considera activa si hay al menos una solicitud de sincronización de contador de mensajes de intercambio abierto o pendiente.

Detalles
Parámetros
[in] messageLayerIsActive
Un valor booleano que indica si la capa de mensajes está activa o no.

MessageReceiveFunct

void(* MessageReceiveFunct)(WeaveMessageLayer *msgLayer, WeaveMessageInfo *msgInfo, PacketBuffer *payload)

Esta función es la devolución de llamada de capa superior que se invoca cuando se recibe un mensaje de Weave mediante UDP.

Detalles
Parámetros
[in] msgLayer
Un puntero para el objeto WeaveMessageLayer.
[in] msgInfo
Un puntero para el objeto WeaveMessageInfo.
[in] payload
Puntero al mensaje de PacketBuffer que contiene el paquete tunelizado recibido.

ReceiveErrorFunct

void(* ReceiveErrorFunct)(WeaveMessageLayer *msgLayer, WEAVE_ERROR err, const IPPacketInfo *pktInfo)

Esta función es la devolución de llamada de capa superior que se invoca cuando se encuentra un error.

Detalles
Parámetros
[in] msgLayer
Un puntero para el objeto WeaveMessageLayer.
[in] err
Se encontró WEAVE_ERROR al recibir datos.
[in] pktInfo
Un puntero de solo lectura al objeto IPPacketInfo.

Estado

 State

El estado de WeaveMessageLayer.

Propiedades
kState_Initialized

Indica el estado en el que se inicializa WeaveMessageLayer.

kState_Initializing

Indica cuándo WeaveMessageLayer está en proceso de inicialización.

kState_NotInitialized

Estado cuando no se inicializa WeaveMessageLayer.

TunneledMsgReceiveFunct

void(* TunneledMsgReceiveFunct)(WeaveMessageLayer *msgLayer, PacketBuffer *payload)

Esta función es la devolución de llamada de capa superior que se invoca cuando se recibe un paquete túnel a través de un túnel UDP local.

Detalles
Parámetros
[in] msgLayer
Un puntero para el objeto WeaveMessageLayer.
[in] payload
Puntero al mensaje de PacketBuffer que contiene el paquete tunelizado recibido.

Atributos públicos

AppState

void * AppState

Un puntero para un objeto de estado específico de la aplicación.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[SOLO LECTURA] El objeto asociado WeaveExchangeManager.

FabricState

WeaveFabricState * FabricState

[READ ONLY] El objeto asociado WeaveFabricState

IncomingConIdleTimeout

uint32_t IncomingConIdleTimeout

Tiempo de espera de inactividad predeterminado (en milisegundos) para las conexiones entrantes.

Inet

InetLayer * Inet

[SOLO LECTURA] El objeto InetLayer asociado.

IsListening

bool IsListening

[SOLO LECTURA] Verdadero si detecta conexiones o mensajes entrantes; de lo contrario, es falso.

OnAcceptError

AcceptErrorFunct OnAcceptError

OnConnectionReceived

ConnectionReceiveFunct OnConnectionReceived

OnMessageReceived

MessageReceiveFunct OnMessageReceived

OnReceiveError

ReceiveErrorFunct OnReceiveError

OnUDPTunneledMessageReceived

TunneledMsgReceiveFunct OnUDPTunneledMessageReceived

SecurityMgr

WeaveSecurityManager * SecurityMgr

[READ ONLY] El objeto asociado WeaveSecurityManager.

Estado

uint8_t State

[READ ONLY] El estado del objeto WeaveMessageLayer.

SystemLayer

System::Layer * SystemLayer

mDropMessage

bool mDropMessage

Interno y solo para depuración. Cuando se configura, WeaveMessageLayer descarta el mensaje y muestra resultados.

Funciones públicas

ClearUnsecuredConnectionListener

WEAVE_ERROR ClearUnsecuredConnectionListener(
  ConnectionReceiveFunct oldOnUnsecuredConnectionReceived,
  CallbackRemovedFunct newOnUnsecuredConnectionCallbacksRemoved
)

CloseEndpoints

WEAVE_ERROR CloseEndpoints(
  void
)

Cierra todos los extremos TCP y UDP abiertos.

Luego, anula cualquier WeaveConnections abierta y cierra cualquier objeto WeaveConnectionTunnel que esté abierto.

Consulta también:
Shutdown().

CreateTunnel

WEAVE_ERROR CreateTunnel(
  WeaveConnectionTunnel **tunPtr,
  WeaveConnection & conOne,
  WeaveConnection & conTwo,
  uint32_t inactivityTimeoutMS
)

Crea un WeaveConnectionTunnel. Para ello, acopla dos WeaveConnections especificadas.

Cuando se crea con éxito, los TCPEndPoints correspondientes a los objetos WeaveConnection del componente se entregan a WeaveConnectionTunnel; de lo contrario, WeaveConnections se cierran.

Detalles
Parámetros
[out] tunPtr
Un puntero para el puntero de un objeto WeaveConnectionTunnel.
[in] conOne
Una referencia al primer objeto WeaveConnection.
[in] conTwo
Una referencia al segundo objeto WeaveConnection.
[in] inactivityTimeoutMS
El tiempo máximo en milisegundos que el túnel de conexión de Weave podría estar inactivo.
Valores que se muestran
WEAVE_NO_ERROR
después de la creación exitosa de WeaveConnectionTunnel.
WEAVE_ERROR_INCORRECT_STATE
Si los objetos del componente WeaveConnection de WeaveConnectionTunnel no están en el estado correcto.
WEAVE_ERROR_NO_MEMORY
Si no se puede crear un objeto WeaveConnectionTunnel nuevo.

DecodeHeader

WEAVE_ERROR DecodeHeader(
  PacketBuffer *msgBuf,
  WeaveMessageInfo *msgInfo,
  uint8_t **payloadStart
)

Decodifica un encabezado de la capa de mensajes de Weave de un mensaje de Weave recibido.

Detalles
Parámetros
[in] msgBuf
Un puntero al objeto PacketBuffer que contiene el mensaje de Weave.
[in] msgInfo
Un puntero a un objeto WeaveMessageInfo que recibirá información sobre el mensaje.
[out] payloadStart
Un puntero para un puntero hacia la posición en el búfer de mensajes una vez que se completa la decodificación.
Valores que se muestran
WEAVE_NO_ERROR
Cuando se decodifique correctamente el encabezado del mensaje.
WEAVE_ERROR_INVALID_MESSAGE_LENGTH
Si el búfer de mensajes que se pasó tiene una longitud no válida.
WEAVE_ERROR_UNSUPPORTED_MESSAGE_VERSION
Si la versión del formato de encabezado de Weave Message no es compatible.

EncodeMessage

WEAVE_ERROR EncodeMessage(
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf,
  WeaveConnection *con,
  uint16_t maxLen,
  uint16_t reserve
)

Codifica un encabezado WeaveMessageLayer en un PacketBuffer.

Detalles
Parámetros
[in] msgInfo
Un puntero a un objeto WeaveMessageInfo que contiene información sobre el mensaje que se codificará.
[in] msgBuf
Un puntero al objeto PacketBuffer que contendrá el mensaje de Weave.
[in] con
Un puntero para el objeto WeaveConnection.
[in] maxLen
La longitud máxima del mensaje de Weave codificado.
[in] reserve
El espacio reservado antes de la carga útil para contener el encabezado del mensaje de Weave.
Valores que se muestran
WEAVE_NO_ERROR
después de codificar correctamente el mensaje.
WEAVE_ERROR_UNSUPPORTED_MESSAGE_VERSION
Si la versión del formato del encabezado de mensaje de Weave no es compatible.
WEAVE_ERROR_INVALID_MESSAGE_LENGTH
si la longitud de la carga útil en el búfer de mensajes es cero.
WEAVE_ERROR_UNSUPPORTED_ENCRYPTION_TYPE
si no se admite el tipo de encriptación en el encabezado del mensaje.
WEAVE_ERROR_MESSAGE_TOO_LONG
si el mensaje codificado superaría el máximo solicitado.
WEAVE_ERROR_BUFFER_TOO_SMALL
si no hay suficiente espacio antes o después de la carga útil del mensaje.
other
errores generados por el objeto de estado fabric cuando se recupera el estado de la sesión.

EncodeMessage

WEAVE_ERROR EncodeMessage(
  const IPAddress & destAddr,
  uint16_t destPort,
  InterfaceId sendIntId,
  WeaveMessageInfo *msgInfo,
  PacketBuffer *payload
)

Codifica un encabezado de la capa de mensajes de Weave en un PacketBuffer.

Detalles
Parámetros
[in] destAddr
Es la dirección IP de destino.
[in] destPort
Es el puerto de destino.
[in] sendIntId
La interfaz en la que se envía el mensaje de Weave.
[in] msgInfo
Un puntero para un objeto WeaveMessageInfo.
[in] payload
Un puntero al objeto PacketBuffer que contendrá el mensaje de Weave.
Valores que se muestran
WEAVE_NO_ERROR
sobre la codificación correcta del mensaje de Weave.
WEAVE_ERROR_UNSUPPORTED_MESSAGE_VERSION
si la versión de Weave Message no es compatible.
WEAVE_ERROR_INVALID_MESSAGE_LENGTH
si la longitud de la carga útil en el búfer de mensajes es cero.
WEAVE_ERROR_UNSUPPORTED_ENCRYPTION_TYPE
si el tipo de encriptación no es compatible.
WEAVE_ERROR_MESSAGE_TOO_LONG
si el mensaje codificado superaría el máximo solicitado.
WEAVE_ERROR_BUFFER_TOO_SMALL
si no hay suficiente espacio antes o después de la carga útil del mensaje.
other
errores generados por el objeto de estado fabric cuando se recupera el estado de la sesión.

EphemeralUDPPortEnabled

bool EphemeralUDPPortEnabled(
  void
) const

Verifica si los intercambios UDP de Weave iniciados localmente deben enviarse desde un puerto de origen UDP efímero.

GetConnectionPoolStats

void GetConnectionPoolStats(
  nl::Weave::System::Stats::count_t & aOutInUse
) const

Obtén la cantidad de WeaveConnections en uso y el tamaño del grupo.

Detalles
Parámetros
[out] aOutInUse
Referencia a size_t, en la que se almacena la cantidad de conexiones en uso.

IPv4ListenEnabled

bool IPv4ListenEnabled(
  void
) const

Verifica si WeaveMessageLayer está configurado para escuchar las comunicaciones entrantes a través de IPv4.

IPv6ListenEnabled

bool IPv6ListenEnabled(
  void
) const

Verifica si WeaveMessageLayer está configurado para escuchar las comunicaciones entrantes a través de IPv4.

Init

WEAVE_ERROR Init(
  InitContext *context
)

Inicializa el objeto de la capa de mensaje de Weave.

Detalles
Parámetros
[in] context
Un puntero para el objeto InitContext.
Valores que se muestran
WEAVE_NO_ERROR
en una inicialización exitosa.
WEAVE_ERROR_INVALID_ARGUMENT
si el objeto InitContext que se pasó es NULL.
WEAVE_ERROR_INCORRECT_STATE
si el estado del objeto WeaveMessageLayer es incorrecto.
other
errores generados desde la capa Inet inferior durante la creación del extremo.

IsBoundToLocalIPv4Address

bool IsBoundToLocalIPv4Address(
  void
) const

Verifica si WeaveMessageLayer está vinculada a una dirección IPv4 local.

IsBoundToLocalIPv6Address

bool IsBoundToLocalIPv6Address(
  void
) const

Verifica si WeaveMessageLayer está vinculada a una dirección IPv6 local.

IsMessageLayerActive

bool IsMessageLayerActive(
  void
)

NewConnection

WeaveConnection * NewConnection(
  void
)

Crea un objeto WeaveConnection nuevo desde un grupo.

Detalles
Qué muestra
un puntero al objeto WeaveConnection recién creado si se ejecuta correctamente; de lo contrario, es NULL.

NewConnectionTunnel

WeaveConnectionTunnel * NewConnectionTunnel(
  void
)

Crea un objeto WeaveConnectionTunnel nuevo desde un grupo.

Detalles
Qué muestra
un puntero para el objeto WeaveConnectionTunnel recién creado si se ejecuta correctamente; de lo contrario, es NULL.

ReEncodeMessage

WEAVE_ERROR ReEncodeMessage(
  PacketBuffer *buf
)

RefreshEndpoints

WEAVE_ERROR RefreshEndpoints(
  void
)

Actualiza los extremos de InetLayer en función del estado actual de las interfaces de red del sistema.

Detalles
Valores que se muestran
WEAVE_NO_ERROR
sobre la actualización exitosa de los extremos.
InetLayer
errores basados en las llamadas para crear extremos TCP/UDP.

ResendMessage

WEAVE_ERROR ResendMessage(
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf
)

Vuelve a enviar un mensaje codificado de Weave mediante el extremo UDP de Inetlayer subyacente.

Detalles
Parámetros
[in] msgInfo
Un puntero para el objeto WeaveMessageInfo.
[in] payload
Un puntero al objeto PacketBuffer que contiene el mensaje codificado de Weave.
Valores que se muestran
WEAVE_NO_ERROR
de enviar correctamente el mensaje a la capa de red.
errors
generados desde el extremo UDP de la capa inferior de Inet durante el envío.

ResendMessage

WEAVE_ERROR ResendMessage(
  const IPAddress & destAddr,
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf
)

Vuelve a enviar un mensaje codificado de Weave mediante el extremo UDP de Inetlayer subyacente.

Detalles
Parámetros
[in] destAddr
Es la dirección IP de destino.
[in] msgInfo
Un puntero para el objeto WeaveMessageInfo.
[in] payload
Un puntero al objeto PacketBuffer que contiene el mensaje codificado de Weave.
Valores que se muestran
WEAVE_NO_ERROR
de enviar correctamente el mensaje a la capa de red.
errors
generados desde el extremo UDP de la capa inferior de Inet durante el envío.

ResendMessage

WEAVE_ERROR ResendMessage(
  const IPAddress & destAddr,
  uint16_t destPort,
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf
)

Vuelve a enviar un mensaje codificado de Weave mediante el extremo UDP de Inetlayer subyacente.

Detalles
Parámetros
[in] destAddr
Es la dirección IP de destino.
[in] destPort
Es el puerto de destino.
[in] msgInfo
Un puntero para el objeto WeaveMessageInfo.
[in] payload
Un puntero al objeto PacketBuffer que contiene el mensaje codificado de Weave.
Valores que se muestran
WEAVE_NO_ERROR
de enviar correctamente el mensaje a la capa de red.
errors
generados desde el extremo UDP de la capa inferior de Inet durante el envío.

ResendMessage

WEAVE_ERROR ResendMessage(
  const IPAddress & destAddr,
  uint16_t destPort,
  InterfaceId interfaceId,
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf
)

Vuelve a enviar un mensaje codificado de Weave mediante el extremo UDP de Inetlayer subyacente.

Nota: Si no se proporcionó la dirección de destino, intenta determinarla a partir del identificador de nodo en el encabezado del mensaje. Falle si no se puede hacer esta acción. -Si la dirección de destino es una dirección de tejido para la estructura local y el emisor no especificó el ID del nodo de destino, extráelo de la dirección de destino.

Detalles
Parámetros
[in] aDestAddr
Es la dirección IP de destino.
[in] destPort
Es el puerto de destino.
[in] interfaceId
La interfaz en la que se envía el mensaje de Weave.
[in] msgInfo
Un puntero para el objeto WeaveMessageInfo.
[in] payload
Un puntero al objeto PacketBuffer que contiene el mensaje codificado de Weave.
Valores que se muestran
WEAVE_NO_ERROR
de enviar correctamente el mensaje a la capa de red.
errors
generados desde el extremo UDP de la capa inferior de Inet durante el envío.

SendMessage

WEAVE_ERROR SendMessage(
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf
)

Envía un mensaje de Weave mediante el extremo UDP de Inetlayer subyacente después de codificarlo.

Detalles
Parámetros
[in] msgInfo
Un puntero a un objeto WeaveMessageInfo que contiene información sobre el mensaje que se enviará.
[in] payload
Un puntero al objeto PacketBuffer que contiene el mensaje codificado de Weave.
Valores que se muestran
WEAVE_NO_ERROR
de enviar correctamente el mensaje a la capa de red.
errors
generados desde el extremo UDP de la capa inferior de Inet durante el envío.

SendMessage

WEAVE_ERROR SendMessage(
  const IPAddress & destAddr,
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf
)

Envía un mensaje de Weave mediante el extremo UDP de Inetlayer subyacente después de codificarlo.

Nota:-El puerto de destino que se usa es WEAVE_PORT. - Si no se proporcionó la dirección de destino, intenta determinarla a partir del identificador de nodo en el encabezado del mensaje. Falle si no se puede hacer esta acción.

-Si la dirección de destino es una dirección de tejido para la estructura local y el emisor no especificó el ID del nodo de destino, extráelo de la dirección de destino.

Detalles
Parámetros
[in] destAddr
Es la dirección IP de destino.
[in] msgInfo
Un puntero a un objeto WeaveMessageInfo que contiene información sobre el mensaje que se enviará.
[in] payload
Un puntero al objeto PacketBuffer que contiene el mensaje codificado de Weave.
Valores que se muestran
WEAVE_NO_ERROR
de enviar correctamente el mensaje a la capa de red.
errors
generados desde el extremo UDP de la capa inferior de Inet durante el envío.

SendMessage

WEAVE_ERROR SendMessage(
  const IPAddress & destAddr,
  uint16_t destPort,
  InterfaceId sendIntfId,
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf
)

Envía un mensaje de Weave mediante el extremo UDP de Inetlayer subyacente después de codificarlo.

Nota: Si no se proporcionó la dirección de destino, intenta determinarla a partir del identificador de nodo en el encabezado del mensaje. Falle si no se puede hacer esta acción. -Si la dirección de destino es una dirección de tejido para la estructura local y el emisor no especificó el ID del nodo de destino, extráelo de la dirección de destino.

Detalles
Parámetros
[in] aDestAddr
Es la dirección IP de destino.
[in] destPort
Es el puerto de destino.
[in] sendIntfId
La interfaz en la que se envía el mensaje de Weave.
[in] msgInfo
Un puntero a un objeto WeaveMessageInfo que contiene información sobre el mensaje que se enviará.
[in] payload
Un puntero al objeto PacketBuffer que contiene el mensaje codificado de Weave.
Valores que se muestran
WEAVE_NO_ERROR
de enviar correctamente el mensaje a la capa de red.
WEAVE_ERROR_INVALID_ADDRESS
Si el destAddr no se especifica o no se puede determinar desde el ID del nodo de destino.
errors
generados desde el extremo UDP de la capa inferior de Inet durante el envío.

SendUDPTunneledMessage

WEAVE_ERROR SendUDPTunneledMessage(
  const IPAddress & destAddr,
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf
)

Es la función para enviar un paquete túnel a través de un túnel UDP local.

Envía un mensaje de datos IPv6 en túnel a través de UDP.

Detalles
Parámetros
[in] msgInfo
Un puntero para un objeto WeaveMessageInfo.
[in] destAddr
Dirección IP del destino del túnel UDP.
[in] msgBuf
Un puntero al objeto PacketBuffer que contiene el paquete que se enviará.
Valores que se muestran
WEAVE_NO_ERROR
de enviar correctamente el mensaje a la capa de red.
WEAVE_ERROR_INVALID_ADDRESS
Si el destAddr no se especifica o no se puede determinar desde el ID del nodo de destino.
errors
generados desde el extremo UDP de la capa inferior de Inet durante el envío.

SetSignalMessageLayerActivityChanged

void SetSignalMessageLayerActivityChanged(
  MessageLayerActivityChangeHandlerFunct messageLayerActivityChangeHandler
)

Configura un controlador de aplicaciones al que se llamará cada vez que cambie la actividad de la capa de mensajes.

Específicamente, la aplicación recibirá una notificación cada vez que:

  • cambia el número de intercambios abiertos.
  • la cantidad de solicitudes pendientes de sincronización del contador de mensajes cambia de cero a, al menos, uno y de nuevo a cero. El controlador se entrega como una señal general que indica si hay conversaciones de Weave en curso o respuestas pendientes. El controlador se debe configurar después de inicializar WeaveMessageLayer. Si cierras WeaveMessageLayer, se borrará el controlador actual.

Detalles
Parámetros
[in] messageLayerActivityChangeHandler
Un puntero a una función a la que se llamará cada vez que cambie la actividad de la capa de mensajes.
Valores que se muestran
None.

SetTCPListenEnabled

void SetTCPListenEnabled(
  bool val
)

Habilita o inhabilita la detección de conexiones TCP entrantes en WeaveMessageLayer.

NOTA: Se debe llamar a RefreshEndpoints() después de que se cambie el estado de escucha de TCP.

SetUDPListenEnabled

void SetUDPListenEnabled(
  bool val
)

Habilita o inhabilita la detección de mensajes UDP entrantes en WeaveMessageLayer.

NOTA: Se debe llamar a RefreshEndpoints() después de que se cambie el estado de escucha de UDP.

SetUnsecuredConnectionListener

WEAVE_ERROR SetUnsecuredConnectionListener(
  ConnectionReceiveFunct newOnUnsecuredConnectionReceived,
  CallbackRemovedFunct newOnUnsecuredConnectionCallbacksRemoved,
  bool force,
  void *listenerState
)

Cierre

WEAVE_ERROR Shutdown(
  void
)

Apaga WeaveMessageLayer.

Cierra todos los extremos abiertos de la capa Inet y restablece todas las devoluciones de llamada de capas superiores, las variables de miembro y los objetos. Una llamada a Shutdown() finaliza el objeto WeaveMessageLayer.

TCPListenEnabled

bool TCPListenEnabled(
  void
) const

Verifica si WeaveMessageLayer está configurado para escuchar las conexiones TCP entrantes.

UDPListenEnabled

bool UDPListenEnabled(
  void
) const

Verifica si WeaveMessageLayer está configurado para escuchar mensajes UDP entrantes.

UnsecuredListenEnabled

bool UnsecuredListenEnabled(
  void
) const

Habilita o inhabilita el inicio de los intercambios UDP de Weave desde un puerto de origen UDP efímero.

NOTA: Se debe llamar a RefreshEndpoints() después de cambiar el estado del puerto efímero. Comprueba si está habilitada la función de escucha no segura.

WeaveMessageLayer

 WeaveMessageLayer(
  void
)

Constructor de capas de mensajes de Weave.

Funciones estáticas públicas

GetMaxWeavePayloadSize

uint32_t GetMaxWeavePayloadSize(
  const PacketBuffer *msgBuf,
  bool isUDP,
  uint32_t udpMTU
)

Obtener el tamaño máximo de carga útil de Weave para una configuración de mensaje y el PacketBuffer suministrado.

El tamaño máximo de la carga útil que se muestra no superará el espacio disponible para una carga útil dentro del PacketBuffer suministrado.

Si el mensaje es UDP, el tamaño máximo de la carga útil que se muestra no generará un mensaje de Weave que no desbordará la MTU de UDP especificada.

Por último, el tamaño máximo de la carga útil que se muestra no generará un mensaje de Weave que exceda el tamaño máximo del mensaje de Weave.

Detalles
Parámetros
[in] msgBuf
Un puntero para el PacketBuffer en el que se escribirá la carga útil del mensaje.
[in] isUDP
Es verdadero si el mensaje es un mensaje UDP.
[in] udpMTU
El tamaño de la MTU de UDP. Se ignora si isUDP es falso.
Qué muestra
el tamaño máximo de carga útil de Weave.

GetPeerDescription

void GetPeerDescription(
  char *buf,
  size_t bufSize,
  uint64_t nodeId,
  const IPAddress *addr,
  uint16_t port,
  InterfaceId interfaceId,
  const WeaveConnection *con
)

Construye una cadena que describe un nodo par y su dirección / información de conexión asociada.

La cadena generada tiene el siguiente formato: 

 ([]:%, con )

Detalles
Parámetros
[in] buf
Un puntero para un búfer en el que se debe escribir la string. El búfer proporcionado debe ser al menos tan grande como kWeavePeerDescription_MaxLength. Si se proporciona un búfer más pequeño, la cadena se truncará para que quepa. El resultado incluirá un carácter de finalización NUL en todos los casos.
[in] bufSize
Tamaño del búfer al que apunta buf.
[in] nodeId
El ID de nodo que se imprimirá.
[in] addr
Un puntero a una dirección IP que se imprimirá o NULL si no se debe imprimir ninguna dirección IP.
[in] port
Un número de puerto IP que se imprimirá. No se imprimirá ningún número de puerto si addr es NULL.
[in] interfaceId
Un InterfaceId que identifica la interfaz que se imprimirá. La cadena de salida contendrá el nombre de la interfaz, tal como lo conoce la pila de red subyacente. No se imprimirá ningún nombre de interfaz si interfacesId es INET_NULL_INTERFACEID o si el valor es NULL.
[in] con
Un puntero a un objeto WeaveConnection cuyo ID de registro se debe imprimir o NULL si no se debe imprimir ningún ID de conexión.

GetPeerDescription

void GetPeerDescription(
  char *buf,
  size_t bufSize,
  const WeaveMessageInfo *msgInfo
)

Construye una cadena que describe un nodo de intercambio de tráfico en función de la información asociada con un mensaje recibido del par.

Detalles
Parámetros
[in] buf
Un puntero para un búfer en el que se debe escribir la string. El búfer proporcionado debe ser al menos tan grande como kWeavePeerDescription_MaxLength. Si se proporciona un búfer más pequeño, la cadena se truncará para que quepa. El resultado incluirá un carácter de finalización NUL en todos los casos.
[in] bufSize
Tamaño del búfer al que apunta buf.
[in] msgInfo
Un puntero para una estructura de WeaveMessageInfo que contiene información sobre el mensaje.