nl::Weave::WeaveConnectionTunnel

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

The definition of the WeaveConnectionTunnel class, which manages a pair of TCPEndPoints whose original WeaveConnections have been coupled, and between which the WeaveMessageLayer forwards all data and connection closures.

Summary

Public types
`ShutdownFunct)(WeaveConnectionTunnel *tun)`	typedef `void(*` This function is the application callback that is invoked when the Weave connection tunnel is shut down.

Public attributes
`AppState`	`void *` A pointer to application-specific state object.
`OnShutdown`	`ShutdownFunct`

Public functions
`LogId(void) const`	`uint16_t`
`Shutdown(void)`	`void` Shutdown the WeaveConnectionTunnel by closing the component endpoints which, in turn, close the corresponding TCP connections.

Public types

ShutdownFunct

void(* ShutdownFunct)(WeaveConnectionTunnel *tun)

This function is the application callback that is invoked when the Weave connection tunnel is shut down.

Details

Parameters

[in] tun

A pointer to the WeaveConnectionTunnel object.

Public attributes

AppState

void * AppState

A pointer to application-specific state object.

OnShutdown

ShutdownFunct OnShutdown

Public functions

LogId

uint16_t LogId(
  void
) const

Shutdown

void Shutdown(
  void
)

Shutdown the WeaveConnectionTunnel by closing the component endpoints which, in turn, close the corresponding TCP connections.

This function terminates the tunnel and any further use of a WeaveConnectionTunnel needs to be initiated by a call to WeaveMessageLayer::NewConnectionTunnel();