Class Tcp

Create a TCP connection from a device throught the network the device is currently connected to.

Hierarchy

Constructors

constructor

Properties

Obniz onconnection? onerror? onreceive? timeout prefixed

Methods

addListener connectWait emit end eventNames fastValidate listenerCount listeners notifyFromObniz off on once readWait removeAllListeners removeListener schemaBasePath validate write

Constructors

constructor

Properties

Obniz

Obniz: Obniz

obniz to be used

Optional onconnection

onconnection?: TCPConnectionCallbackFunction

Callback function is called when there is a change in TCP connection status.

// Javascript Example
var tcp = obniz.getFreeTcp();

tcp.onconnection = data => {
 console.log(data);
};
tcp.connectWait(80,"obniz.io");

Optional onerror

onerror?: TCPErrorCallbackFunction

You can get the error message that occurred when connecting.

// Javascript Example
var tcp = obniz.getFreeTcp();
tcp.connectWait(80,"obniz.io");

tcp.onerror = state => {
  console.log(state);
};

Optional onreceive

onreceive?: TCPReceiveCallbackFunction

Callback function is called when TCP is received.

// Javascript Example
var tcp = obniz.getFreeTcp();
tcp.connectWait(80,"obniz.io");

tcp.onreceive = data => {
  console.log(data);
};

timeout

timeout: number = ...

Rsponse waiting timeout in milliseconds

Static prefixed

prefixed: string | boolean

Methods

addListener

  • Parameters

    • event: string
    • fn: ListenerFn
    • Optional context: any

    Returns Tcp

connectWait

  • Starts a connection on the port and domain for which TCP is specified.

    // Javascript Example
    var tcp = obniz.getFreeTcp();
    tcp.connectWait(80,"obniz.io");

    Parameters

    • port: number
    • domain: string

    Returns Promise<void>

emit

  • Calls each of the listeners registered for a given event.

    Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

eventNames

  • Return an array listing the events for which the emitter has registered listeners.

    Returns string[]

fastValidate

listenerCount

  • Return the number of listeners listening to a given event.

    Parameters

    • event: string

    Returns number

listeners

  • Return the listeners registered for a given event.

    Parameters

    • event: string

    Returns ListenerFn[]

notifyFromObniz

off

  • Parameters

    • event: string
    • Optional fn: ListenerFn
    • Optional context: any
    • Optional once: boolean

    Returns Tcp

on

  • Add a listener for a given event.

    Parameters

    • event: string
    • fn: ListenerFn
    • Optional context: any

    Returns Tcp

once

  • Add a one-time listener for a given event.

    Parameters

    • event: string
    • fn: ListenerFn
    • Optional context: any

    Returns Tcp

readWait

  • Wait for TCP reception.

    // Javascript Example
    var tcp = obniz.getFreeTcp();
    tcp.connectWait(80,"obniz.io");

    let data = await tcp.readWait();
    console.log(data);

    Returns Promise<number[]>

removeAllListeners

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: string

    Returns Tcp

removeListener

  • Remove the listeners of a given event.

    Parameters

    • event: string
    • Optional fn: ListenerFn
    • Optional context: any
    • Optional once: boolean

    Returns Tcp

schemaBasePath

validate

write

  • The argument data is sent by TCP.

    If you pass a string or Array type argument, the data will be sent.

    // Javascript Example
    var tcp = obniz.getFreeTcp();
    tcp.connectWait(80,"obniz.io");

    // Array
    tcp.write([0,1,2,3,4]);

    // Text
    tcp.write('hello');

    Parameters

    • data: string | number | number[] | Buffer

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc