webduino-js

  • API Docs for Version: 0.7.0

    • Show:

    webduino.Transport

    Extends webduino.EventEmitter

    A messaging mechanism to carry underlying firmata messages. This is an abstract class meant to be extended.

    Table of Contents

    Constructor

    webduino.Transport
    (
    • options
    )

    Defined in src/core/Transport.js:52

    Parameters:

    • options Object

      Options to build the transport instance.

    Methods

    addListener
    (
    • type
    • listener
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:117

    Add a listener for a certain type of event.

    Parameters:

    • type String

      Event type.

    • listener Function

      Event listener.

    close ()

    Defined in src/core/Transport.js:94

    Close and terminate the transport.

    emit
    (
    • type
    • object,...
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:58

    Emit an event of certain type.

    Parameters:

    • type String

      Event type.

    • [object,...] Object optional

      Event object(s).

    flush ()

    Defined in src/core/Transport.js:103

    Flush any buffered data of the transport.

    listeners
    (
    • type
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:310

    Return the listener list bound to certain type of event.

    Parameters:

    • type String

      Evnet type.

    on
    (
    • type
    • listener
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:174

    Alias for EventEmitter.addListener(type, listener)

    Parameters:

    • type String

      Event type.

    • listener Function

      Event listener.

    once
    (
    • type
    • listener
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:183

    Add a one-time listener for a certain type of event.

    Parameters:

    • type String

      Event type.

    • listener Function

      Event listener.

    removeAllListeners
    (
    • type
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:264

    Remove all listeners of certain type.

    Parameters:

    • type String

      Event type.

    removeListener
    (
    • type
    • listener
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:211

    Remove a listener for certain type of event.

    Parameters:

    • type String

      Event type.

    • listener Function

      Event listener.

    send
    (
    • payload
    )

    Defined in src/core/Transport.js:84

    Send payload through the transport.

    Parameters:

    • payload Array

      The actual data to be sent.

    setMaxListeners
    (
    • n
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:45

    Set maximum number of listeners that is allow to bind on an emitter.

    Parameters:

    • n Number

      Number of listeners.

    Attributes

    isOpen

    Boolean readonly

    Defined in src/core/Transport.js:71

    Indicates if the state of the transport is open.

    Events

    TransportEvent.CLOSE

    Defined in src/core/Transport.js:37

    Fires when a transport is closed.

    TransportEvent.ERROR

    Defined in src/core/Transport.js:30

    Fires when a transport get an error.

    TransportEvent.MESSAGE

    Defined in src/core/Transport.js:23

    Fires when a transport receives a message.

    TransportEvent.OPEN

    Defined in src/core/Transport.js:16

    Fires when a transport is opened.

    TransportEvent.REOPEN

    Defined in src/core/Transport.js:44

    Fires when a transport is re-opened.