nl::Weave::WeaveMessageLayer

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

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

Resumen

Emplea uno de varios 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 la 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 la 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 el cambio de la actividad de la capa de mensajes.
MessageReceiveFunct)(WeaveMessageLayer *msgLayer, WeaveMessageInfo *msgInfo, PacketBuffer *payload) typedef
void(*
Esta función es la devolución de llamada de la capa superior que se invoca al recibir 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 la capa superior que se invoca cuando se produce un error.
State{
  kState_NotInitialized = 0,
  kState_Initializing = 1,
  kState_Initialized = 2
} 		enum
Es el estado de WeaveMessageLayer.
TunneledMsgReceiveFunct)(WeaveMessageLayer *msgLayer, PacketBuffer *payload) typedef
void(*
Esta función es la devolución de llamada de la capa superior que se invoca cuando se recibe un paquete de tunelización a través de un túnel UDP local.

Atributos públicos
AppState
void *
Un puntero a un objeto de estado específico de la aplicación.
ExchangeMgr
[SOLO LECTURA] El objeto WeaveExchangeManager asociado.
FabricState
[SOLO LECTURA] El objeto WeaveFabricState asociado.
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
[READ ONLY] Es verdadero si se detectan conexiones o mensajes entrantes. De lo contrario, es falso.
OnAcceptError
OnConnectionReceived
OnMessageReceived
OnReceiveError
OnUDPTunneledMessageReceived
SecurityMgr
[SOLO LECTURA] El objeto WeaveSecurityManager asociado.
State
uint8_t
[SOLO LECTURA] El estado del objeto WeaveMessageLayer.
SystemLayer
mDropMessage
bool
Interno y solo para depuración Cuando se establece, WeaveMessageLayer descarta el mensaje y muestra un resultado.

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 a través del acoplamiento de dos WeaveConnections especificados.
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 packageBuffer.
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
Comprueba 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á configurada para escuchar las comunicaciones entrantes a través de IPv4.
IPv6ListenEnabled(void) const
bool
Verifica si WeaveMessageLayer está configurada para escuchar las comunicaciones entrantes a través de IPv4.
Init(InitContext *context)
Inicializa el objeto de la capa de mensajes 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 a partir de un grupo.
NewConnectionTunnel(void)
Crea un objeto WeaveConnectionTunnel nuevo a partir de 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 de Weave codificado con el extremo UDP subyacente de Inetlayer.
ResendMessage(const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Vuelve a enviar un mensaje de Weave codificado con el extremo UDP subyacente de Inetlayer.
ResendMessage(const IPAddress & destAddr, uint16_t destPort, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Vuelve a enviar un mensaje de Weave codificado con el extremo UDP subyacente de Inetlayer.
ResendMessage(const IPAddress & destAddr, uint16_t destPort, InterfaceId interfaceId, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Vuelve a enviar un mensaje de Weave codificado con el extremo UDP subyacente de Inetlayer.
SendMessage(WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Enviar un mensaje de Weave con el extremo UDP subyacente de Inetlayer después de codificarlo
SendMessage(const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Enviar un mensaje de Weave con el extremo UDP subyacente de Inetlayer después de codificarlo
SendMessage(const IPAddress & destAddr, uint16_t destPort, InterfaceId sendIntfId, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Enviar un mensaje de Weave con el extremo UDP subyacente de Inetlayer después de codificarlo
SendUDPTunneledMessage(const IPAddress & destAddr, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
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 escucha de conexiones TCP entrantes en WeaveMessageLayer.
SetUDPListenEnabled(bool val)
void
Habilita o inhabilita la escucha 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á configurada para escuchar conexiones TCP entrantes.
UDPListenEnabled(void) const
bool
Verifica si WeaveMessageLayer está configurada para escuchar mensajes UDP entrantes.
UnsecuredListenEnabled(void) const
bool
Habilita o inhabilita el inicio de 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
Obtiene el tamaño máximo de la carga útil de Weave para una configuración de mensaje y el packageBuffer proporcionado.
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 de intercambio de tráfico y su dirección o 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 intercambio de tráfico.

Clases
nl::Weave::WeaveMessageLayer::InitContext

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 la capa superior para informar un error durante el manejo de una conexión TCP entrante.

Detalles
Parámetros
[in] msgLayer
Un puntero al objeto WeaveMessageLayer.
[in] err
Se encontró el error WEAVE_ERROR al manejar 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 la capa superior para controlar una conexión TCP entrante.

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

MessageLayerActivityChangeHandlerFunct

void(* MessageLayerActivityChangeHandlerFunct)(bool messageLayerIsActive)

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

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

Detalles
Parámetros
[in] messageLayerIsActive
Es 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 la capa superior que se invoca al recibir un mensaje de Weave mediante UDP.

Detalles
Parámetros
[in] msgLayer
Un puntero al objeto WeaveMessageLayer.
[in] msgInfo
Un puntero al objeto WeaveMessageInfo.
[in] payload
Es un puntero al mensaje de PackageBuffer que contiene un paquete tunelizado recibido.

ReceiveErrorFunct

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

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

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

Estado

 State

Es el estado de WeaveMessageLayer.

Propiedades
kState_Initialized

Es el estado cuando se inicializa WeaveMessageLayer.

kState_Initializing

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

kState_NotInitialized

Es el estado cuando no se inicializa WeaveMessageLayer.

TunneledMsgReceiveFunct

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

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

Detalles
Parámetros
[in] msgLayer
Un puntero al objeto WeaveMessageLayer.
[in] payload
Es un puntero al mensaje de PackageBuffer que contiene un paquete tunelizado recibido.

Atributos públicos

AppState

void * AppState

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

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[SOLO LECTURA] El objeto WeaveExchangeManager asociado.

FabricState

WeaveFabricState * FabricState

[SOLO LECTURA] El objeto WeaveFabricState asociado.

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

[READ ONLY] Es verdadero si se detectan 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 WeaveSecurityManager asociado.

Estado

uint8_t State

[SOLO LECTURA] El estado del objeto WeaveMessageLayer.

SystemLayer

System::Layer * SystemLayer

mDropMessage

bool mDropMessage

Interno y solo para depuración Cuando se establece, WeaveMessageLayer descarta el mensaje y muestra un resultado.

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 abierto y cierra los objetos WeaveConnectionTunnel abiertos.

Consulta también:
Shutdown().

CreateTunnel

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

Crea un WeaveConnectionTunnel a través de la vinculación de dos WeaveConnections especificados.

Cuando se crea correctamente, los TCPEndPoints correspondientes a los objetos WeaveConnection del componente se entregan a WeaveConnectionTunnel. De lo contrario, se cierran las WeaveConnections.

Detalles
Parámetros
[out] tunPtr
Un puntero al 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 puede estar inactivo.
Valores de retorno
WEAVE_NO_ERROR
en la creación exitosa de WeaveConnectionTunnel.
WEAVE_ERROR_INCORRECT_STATE
Si los objetos componentes 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 packageBuffer que contiene el mensaje de Weave.
[in] msgInfo
Un puntero para un objeto WeaveMessageInfo que recibirá información sobre el mensaje.
[out] payloadStart
Un puntero para un puntero de la posición en el búfer de mensajes una vez que se completa la decodificación.
Valores de retorno
WEAVE_NO_ERROR
Durante la decodificación correcta del encabezado del mensaje.
WEAVE_ERROR_INVALID_MESSAGE_LENGTH
Si el búfer del mensaje que se pasó tiene una longitud no válida.
WEAVE_ERROR_UNSUPPORTED_MESSAGE_VERSION
Si la versión del formato del encabezado de mensaje de Weave 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 packageBuffer.

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 packageBuffer que retendría el mensaje de Weave.
[in] con
Un puntero al 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 de retorno
WEAVE_NO_ERROR
sobre la correcta codificación del 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 el tipo de encriptación en el encabezado del mensaje no es compatible.
WEAVE_ERROR_MESSAGE_TOO_LONG
si el mensaje codificado fuera más largo que el máximo solicitado.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si no hay espacio suficiente antes o después de la carga útil del mensaje.
other
errores generados por el objeto de estado de la estructura 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 packageBuffer.

Detalles
Parámetros
[in] destAddr
La dirección IP de destino.
[in] destPort
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 packageBuffer que retendría el mensaje de Weave.
Valores de retorno
WEAVE_NO_ERROR
sobre la correcta codificación 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 fuera más largo que el máximo solicitado.
WEAVE_ERROR_BUFFER_TOO_SMALL
Si no hay espacio suficiente antes o después de la carga útil del mensaje.
other
errores generados por el objeto de estado de la estructura cuando se recupera el estado de la sesión.

EphemeralUDPPortEnabled

bool EphemeralUDPPortEnabled(
  void
) const

Comprueba 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á configurada para escuchar las comunicaciones entrantes a través de IPv4.

IPv6ListenEnabled

bool IPv6ListenEnabled(
  void
) const

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

Init

WEAVE_ERROR Init(
  InitContext *context
)

Inicializa el objeto de la capa de mensajes de Weave.

Detalles
Parámetros
[in] context
Un puntero al objeto InitContext.
Valores de retorno
WEAVE_NO_ERROR
en la inicialización exitosa.
WEAVE_ERROR_INVALID_ARGUMENT
si el objeto InitContext pasado es NULL.
WEAVE_ERROR_INCORRECT_STATE
si el estado del objeto WeaveMessageLayer es incorrecto.
other
generados desde la capa de 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 a partir de un grupo.

Detalles
Resultado que se muestra
un puntero al objeto WeaveConnection recién creado si tiene éxito; de lo contrario, será NULL.

NewConnectionTunnel

WeaveConnectionTunnel * NewConnectionTunnel(
  void
)

Crea un objeto WeaveConnectionTunnel nuevo a partir de un grupo.

Detalles
Resultado que se muestra
un puntero al objeto WeaveConnectionTunnel recién creado si se realiza correctamente, de lo contrario, será 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 de retorno
WEAVE_NO_ERROR
en la actualización exitosa de los extremos.
InetLayer
errores basados en llamadas para crear extremos TCP/UDP.

ResendMessage

WEAVE_ERROR ResendMessage(
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf
)

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

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

ResendMessage

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

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

Detalles
Parámetros
[in] destAddr
La dirección IP de destino.
[in] msgInfo
Un puntero al objeto WeaveMessageInfo.
[in] payload
Un puntero al objeto packageBuffer que contiene el mensaje codificado de Weave.
Valores de retorno
WEAVE_NO_ERROR
para enviar correctamente el mensaje a la capa de red.
errors
generados desde el extremo UDP inferior de la capa 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 de Weave codificado con el extremo UDP subyacente de Inetlayer.

Detalles
Parámetros
[in] destAddr
La dirección IP de destino.
[in] destPort
El puerto de destino.
[in] msgInfo
Un puntero al objeto WeaveMessageInfo.
[in] payload
Un puntero al objeto packageBuffer que contiene el mensaje codificado de Weave.
Valores de retorno
WEAVE_NO_ERROR
para enviar correctamente el mensaje a la capa de red.
errors
generados desde el extremo UDP inferior de la capa 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 de Weave codificado con el extremo UDP subyacente de Inetlayer.

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

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

SendMessage

WEAVE_ERROR SendMessage(
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf
)

Enviar un mensaje de Weave con el extremo UDP subyacente de Inetlayer 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 packageBuffer que contiene el mensaje codificado de Weave.
Valores de retorno
WEAVE_NO_ERROR
para enviar correctamente el mensaje a la capa de red.
errors
generados desde el extremo UDP inferior de la capa de Inet durante el envío.

SendMessage

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

Enviar un mensaje de Weave con el extremo UDP subyacente de Inetlayer después de codificarlo

Nota: El puerto de destino utilizado es WEAVE_PORT. - Si no se suministró la dirección de destino, intente determinarla a partir del identificador de nodo en el encabezado del mensaje. Fallará si no se puede hacer.

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

Detalles
Parámetros
[in] destAddr
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 packageBuffer que contiene el mensaje codificado de Weave.
Valores de retorno
WEAVE_NO_ERROR
para enviar correctamente el mensaje a la capa de red.
errors
generados desde el extremo UDP inferior de la capa de Inet durante el envío.

SendMessage

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

Enviar un mensaje de Weave con el extremo UDP subyacente de Inetlayer después de codificarlo

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

Detalles
Parámetros
[in] aDestAddr
La dirección IP de destino.
[in] destPort
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 packageBuffer que contiene el mensaje codificado de Weave.
Valores de retorno
WEAVE_NO_ERROR
para enviar correctamente el mensaje a la capa de red.
WEAVE_ERROR_INVALID_ADDRESS
Si no se especifica destAddr o no se puede determinar a partir del ID del nodo de destino.
errors
generados desde el extremo UDP inferior de la capa de Inet durante el envío.

SendUDPTunneledMessage

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

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

Enviar 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
IPAddress del destino del túnel UDP.
[in] msgBuf
Un puntero al objeto PackageBuffer que contiene el paquete que se enviará.
Valores de retorno
WEAVE_NO_ERROR
para enviar correctamente el mensaje a la capa de red.
WEAVE_ERROR_INVALID_ADDRESS
Si no se especifica destAddr o no se puede determinar a partir del ID del nodo de destino.
errors
generados desde el extremo UDP inferior de la capa 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 ocurra lo siguiente:

  • cambia la cantidad de intercambios abiertos.
  • la cantidad de solicitudes de sincronización de contadores de mensajes pendientes cambia de cero a al menos una y otra vez a cero. El controlador se entrega como indicador general que indica si hay conversaciones de Weave en curso o respuestas pendientes. El controlador debe configurarse después de que se haya inicializado WeaveMessageLayer. Si cierras WeaveMessageLayer, se borrará el controlador actual.

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

SetTCPListenEnabled

void SetTCPListenEnabled(
  bool val
)

Habilita o inhabilita la escucha de conexiones TCP entrantes en WeaveMessageLayer.

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

SetUDPListenEnabled

void SetUDPListenEnabled(
  bool val
)

Habilita o inhabilita la escucha de mensajes UDP entrantes en WeaveMessageLayer.

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

SetUnsecuredConnectionListener

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

Cierre

WEAVE_ERROR Shutdown(
  void
)

Cierra WeaveMessageLayer.

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

TCPListenEnabled

bool TCPListenEnabled(
  void
) const

Verifica si WeaveMessageLayer está configurada para escuchar conexiones TCP entrantes.

UDPListenEnabled

bool UDPListenEnabled(
  void
) const

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

UnsecuredListenEnabled

bool UnsecuredListenEnabled(
  void
) const

Habilita o inhabilita el inicio de 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. Verifica si está habilitada la 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
)

Obtiene el tamaño máximo de la carga útil de Weave para una configuración de mensaje y el packageBuffer proporcionado.

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

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

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

Detalles
Parámetros
[in] msgBuf
Un puntero para PackageBuffer 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.
Resultado que se 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 de intercambio de tráfico y su dirección o 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 cadena. El búfer proporcionado debe ser al menos tan grande como kWeavePeerDescription_MaxLength. Si se proporciona un búfer más pequeño, la string se truncará para que quepa. El resultado incluirá un carácter de finalización NUL en todos los casos.
[in] bufSize
El tamaño del búfer al que apunta el buf.
[in] nodeId
El ID del nodo que se imprimirá.
[in] addr
Un puntero a una dirección IP para 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 como lo conoce la pila de red subyacente. No se imprimirá ningún nombre de interfaz si InterfaceId es INET_NULL_INTERFACEID o si addr es NULL.
[in] con
Un puntero para 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 intercambio de tráfico.

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