Skip to main content

NativeCoapTransport

@totemsdk/edge-coap


@totemsdk/edge-coap / NativeCoapTransport

Class: NativeCoapTransport

CoAP transport port — injected by the caller.

CoAP (RFC 7252) runs over UDP. The caller provides the socket. Messages are confirmable (CON), non-confirmable (NON), acknowledgement (ACK), or reset (RST).

Implements

Constructors

Constructor

new NativeCoapTransport(config?): NativeCoapTransport

Parameters

config?

NativeCoapConfig = {}

Returns

NativeCoapTransport

Methods

bind()

bind(_port): Promise<void>

Bind to a local port.

Parameters

_port

number

Returns

Promise<void>

Implementation of

CoapTransportPort.bind


close()

close(): Promise<void>

Close the socket.

Returns

Promise<void>

Implementation of

CoapTransportPort.close


onError()

onError(handler): () => void

Register a handler for socket errors.

Parameters

handler

(err) => void

Returns

() => void

Implementation of

CoapTransportPort.onError


onMessage()

onMessage(handler): () => void

Register a handler for inbound CoAP messages.

Parameters

handler

(message, remote) => void

Returns

() => void

Implementation of

CoapTransportPort.onMessage


send()

send(host, port, message): Promise<void>

Send a CoAP message to a remote endpoint.

Parameters

host

string

port

number

message

Uint8Array

Returns

Promise<void>

Implementation of

CoapTransportPort.send