Class AbstractTransport`Abstract`

Abstract base class for all transport implementations. Provides a default implementation for decoding raw rosbridge messages.

Hierarchy

EventEmitter<
    {
        close: [TransportEvent];
        error: [TransportEvent];
        message: [RosbridgeMessageBase];
        open: [TransportEvent];
    },
>
- AbstractTransport

Implements

ITransport

Index

Constructors

constructor

new AbstractTransport(): AbstractTransport
Returns AbstractTransport
Inherited from EventEmitter<{ open: [TransportEvent]; close: [TransportEvent]; error: [TransportEvent]; message: [RosbridgeMessageBase]; }>.constructor

Properties

`Static`prefixed

prefixed: string | boolean

Methods

addListener

addListener<T extends "error" | "message" | "open" | "close">(
    event: T,
    fn: (
        ...args: ArgumentMap<
            {
                close: [unknown];
                error: [unknown];
                message: [RosbridgeMessageBase];
                open: [unknown];
            },
        >[Extract<T, "error" | "message" | "open" | "close">],
    ) => void,
    context?: any,
): this
Type Parameters
- T extends "error" | "message" | "open" | "close"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<
          {
              close: [unknown];
              error: [unknown];
              message: [RosbridgeMessageBase];
              open: [unknown];
          },
      >[Extract<T, "error" | "message" | "open" | "close">],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

`Abstract`close

close(): void
Returns void
Implementation of ITransport.close
- Defined in src/core/transport/Transport.ts:80

emit

emit<T extends "error" | "message" | "open" | "close">(
    event: T,
    ...args: ArgumentMap<
        {
            close: [unknown];
            error: [unknown];
            message: [RosbridgeMessageBase];
            open: [unknown];
        },
    >[Extract<T, "error" | "message" | "open" | "close">],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends "error" | "message" | "open" | "close"
Parameters
- event: T
- ...args: ArgumentMap<
      {
          close: [unknown];
          error: [unknown];
          message: [RosbridgeMessageBase];
          open: [unknown];
      },
  >[Extract<T, "error" | "message" | "open" | "close">]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): ("error" | "message" | "open" | "close")[]
Return an array listing the events for which the emitter has registered listeners.

Returns ("error" | "message" | "open" | "close")[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

`Protected`handleRawMessage

handleRawMessage(data: unknown): void
Decodes a raw message received from the transport and emits it as a RosbridgeMessage over the "message" event. If an error occurs, it is emitted as an "error" event.

The default implementation handles multiple compression formats and fragment messages. Subclasses may override this method to provide custom handling of raw messages and when to emit messages.
Parameters
- data: unknown
Returns void
- Defined in src/core/transport/Transport.ts:95

`Abstract`isClosed

isClosed(): boolean
Returns boolean
Implementation of ITransport.isClosed
- Defined in src/core/transport/Transport.ts:84

`Abstract`isClosing

isClosing(): boolean
Returns boolean
Implementation of ITransport.isClosing
- Defined in src/core/transport/Transport.ts:83

`Abstract`isConnecting

isConnecting(): boolean
Returns boolean
Implementation of ITransport.isConnecting
- Defined in src/core/transport/Transport.ts:81

`Abstract`isOpen

isOpen(): boolean
Returns boolean
Implementation of ITransport.isOpen
- Defined in src/core/transport/Transport.ts:82

listenerCount

listenerCount(event: "error" | "message" | "open" | "close"): number
Return the number of listeners listening to a given event.
Parameters
- event: "error" | "message" | "open" | "close"
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends "error" | "message" | "open" | "close">(
    event: T,
): (
    (
        ...args: ArgumentMap<
            {
                close: [unknown];
                error: [unknown];
                message: [RosbridgeMessageBase];
                open: [unknown];
            },
        >[Extract<T, "error" | "message" | "open" | "close">],
    ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends "error" | "message" | "open" | "close"
Parameters
- event: T
Returns (
    (
        ...args: ArgumentMap<
            {
                close: [unknown];
                error: [unknown];
                message: [RosbridgeMessageBase];
                open: [unknown];
            },
        >[Extract<T, "error" | "message" | "open" | "close">],
    ) => void
)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T extends "error" | "message" | "open" | "close">(
    event: T,
    fn?: (
        ...args: ArgumentMap<
            {
                close: [unknown];
                error: [unknown];
                message: [RosbridgeMessageBase];
                open: [unknown];
            },
        >[Extract<T, "error" | "message" | "open" | "close">],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends "error" | "message" | "open" | "close"
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<
          {
              close: [unknown];
              error: [unknown];
              message: [RosbridgeMessageBase];
              open: [unknown];
          },
      >[Extract<T, "error" | "message" | "open" | "close">],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends "error" | "message" | "open" | "close">(
    event: T,
    fn: (
        ...args: ArgumentMap<
            {
                close: [unknown];
                error: [unknown];
                message: [RosbridgeMessageBase];
                open: [unknown];
            },
        >[Extract<T, "error" | "message" | "open" | "close">],
    ) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends "error" | "message" | "open" | "close"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<
          {
              close: [unknown];
              error: [unknown];
              message: [RosbridgeMessageBase];
              open: [unknown];
          },
      >[Extract<T, "error" | "message" | "open" | "close">],
  ) => void
- Optionalcontext: any
Returns this
Implementation of ITransport.on
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends "error" | "message" | "open" | "close">(
    event: T,
    fn: (
        ...args: ArgumentMap<
            {
                close: [unknown];
                error: [unknown];
                message: [RosbridgeMessageBase];
                open: [unknown];
            },
        >[Extract<T, "error" | "message" | "open" | "close">],
    ) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends "error" | "message" | "open" | "close"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<
          {
              close: [unknown];
              error: [unknown];
              message: [RosbridgeMessageBase];
              open: [unknown];
          },
      >[Extract<T, "error" | "message" | "open" | "close">],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: "error" | "message" | "open" | "close"): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: "error" | "message" | "open" | "close"
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends "error" | "message" | "open" | "close">(
    event: T,
    fn?: (
        ...args: ArgumentMap<
            {
                close: [unknown];
                error: [unknown];
                message: [RosbridgeMessageBase];
                open: [unknown];
            },
        >[Extract<T, "error" | "message" | "open" | "close">],
    ) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends "error" | "message" | "open" | "close"
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<
          {
              close: [unknown];
              error: [unknown];
              message: [RosbridgeMessageBase];
              open: [unknown];
          },
      >[Extract<T, "error" | "message" | "open" | "close">],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

`Abstract`send

send(message: RosbridgeMessage): void
Parameters
- message: RosbridgeMessage
Returns void
Implementation of ITransport.send
- Defined in src/core/transport/Transport.ts:79

Class AbstractTransportAbstract

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AbstractTransport

Properties

Staticprefixed

Methods

addListener

Type Parameters

Parameters

Returns this

Abstractclose

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns ("error" | "message" | "open" | "close")[]

ProtectedhandleRawMessage

Parameters

Returns void

AbstractisClosed

Returns boolean

AbstractisClosing

Returns boolean

AbstractisConnecting

Returns boolean

AbstractisOpen

Returns boolean

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ( ...args: ArgumentMap< { close: [unknown]; error: [unknown]; message: [RosbridgeMessageBase]; open: [unknown]; }, >[Extract<T, "error" | "message" | "open" | "close">], ) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

Abstractsend

Parameters

Returns void

Settings

On This Page

Class AbstractTransport`Abstract`

`Static`prefixed

`Abstract`close

`Protected`handleRawMessage

`Abstract`isClosed

`Abstract`isClosing

`Abstract`isConnecting

`Abstract`isOpen

Returns (
(
...args: ArgumentMap<
{
close: [unknown];
error: [unknown];
message: [RosbridgeMessageBase];
open: [unknown];
},
>[Extract<T, "error" | "message" | "open" | "close">],
) => void
)[]

`Abstract`send