Gateway#
API and Callbacks for the Gateway Component.
Software that supports a CLI based application running on a gateway-style device that has a POSIX compatible operating system. This plugin is NOT compatible with an system-on-a-chip (SOC) platform.
API#
const bool
void
gatewayBackchannelStop(void)
EmberStatus
backchannelStartServer(uint8_t port)
EmberStatus
backchannelStopServer(uint8_t port)
EmberStatus
backchannelReceive(uint8_t port, char *data)
EmberStatus
backchannelSend(uint8_t port, uint8_t *data, uint8_t length)
EmberStatus
backchannelClientConnectionCleanup(uint8_t port)
backchannelCheckConnection(uint8_t port, bool waitForConnection)
EmberStatus
EmberStatus
backchannelCloseConnection(uint8_t port)
EmberStatus
backchannelServerPrintf(const char *formatString,...)
EmberStatus
backchannelClientPrintf(uint8_t port, const char *formatString,...)
EmberStatus
backchannelClientVprintf(uint8_t port, const char *formatString, va_list ap)
Enumerations#
enum
Typedefs#
typedef uint8_t
API Documentation#
gatewayBackchannelStop#
void gatewayBackchannelStop (void )
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
backchannelStartServer#
EmberStatus backchannelStartServer (uint8_t port)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | port |
backchannelStopServer#
EmberStatus backchannelStopServer (uint8_t port)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | port |
backchannelReceive#
EmberStatus backchannelReceive (uint8_t port, char * data)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | port | |
| char * | N/A | data |
backchannelSend#
EmberStatus backchannelSend (uint8_t port, uint8_t * data, uint8_t length)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | port | |
| uint8_t * | N/A | data | |
| uint8_t | N/A | length |
backchannelClientConnectionCleanup#
EmberStatus backchannelClientConnectionCleanup (uint8_t port)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | port |
backchannelCheckConnection#
BackchannelState backchannelCheckConnection (uint8_t port, bool waitForConnection)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | port | |
| bool | N/A | waitForConnection |
backchannelMapStandardInputOutputToRemoteConnection#
EmberStatus backchannelMapStandardInputOutputToRemoteConnection (int port)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| int | N/A | port |
backchannelCloseConnection#
EmberStatus backchannelCloseConnection (uint8_t port)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | port |
backchannelServerPrintf#
EmberStatus backchannelServerPrintf (const char * formatString, ... )
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| const char * | N/A | formatString | |
| ... | N/A |
backchannelClientPrintf#
EmberStatus backchannelClientPrintf (uint8_t port, const char * formatString, ... )
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | port | |
| const char * | N/A | formatString | |
| ... | N/A |
backchannelClientVprintf#
EmberStatus backchannelClientVprintf (uint8_t port, const char * formatString, va_list ap)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | port | |
| const char * | N/A | formatString | |
| va_list | N/A | ap |