Class Service<TRequest, TResponse>

A ROS service client.

Type Parameters

TRequest
TResponse

Hierarchy

EventEmitter
- Service

Index

Constructors

constructor

new Service<TRequest, TResponse>(
options: { name: string; ros: Ros; serviceType: string },
): Service<TRequest, TResponse>
Type Parameters
- TRequest
- TResponse
Parameters
- options: { name: string; ros: Ros; serviceType: string }
  - name: string
    The service name, like '/add_two_ints'.
  - ros: Ros
    The ROSLIB.Ros connection handle.
  - serviceType: string
    The service type, like 'rospy_tutorials/AddTwoInts'.
Returns Service<TRequest, TResponse>
Overrides EventEmitter.constructor
- Defined in src/core/Service.ts:42

Properties

isAdvertised

isAdvertised: boolean = false

name

name: string

ros

ros: Ros

serviceType

serviceType: string

`Static`prefixed

prefixed: string | boolean

Methods

addListener

addListener<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

advertise

advertise(
callback: (request: TRequest, response: Partial<TResponse>) => boolean,
): Promise<void>
Advertise the service. This turns the Service object from a client into a server. The callback will be called with every request that's made on this service.
Parameters
- callback: (request: TRequest, response: Partial<TResponse>) => boolean
  This works similarly to the callback for a C++ service in that you should take care not to overwrite the response object. Instead, only modify the values within.
Returns Promise<void>
- Defined in src/core/Service.ts:104

advertiseAsync

advertiseAsync(
callback: (request: TRequest) => Promise<TResponse>,
): Promise<void>
An alternate form of Service advertisement that supports a modern Promise-based interface for use with async/await.
Parameters
- callback: (request: TRequest) => Promise<TResponse>
  An asynchronous callback processing the request and returning a response.
Returns Promise<void>
- Defined in src/core/Service.ts:220

callService

callService(
    request: TRequest,
    callback?: (response: TResponse) => void,
    failedCallback?: (error: string) => void,
    timeout?: number,
): void
Call the service. Returns the service response in the callback. Does nothing if this service is currently advertised.
Parameters
- request: TRequest
  The service request to send.
- Optionalcallback: (response: TResponse) => void
  Function with the following params:
- OptionalfailedCallback: (error: string) => void = console.error
  The callback function when the service call failed with params:
- Optionaltimeout: number
  Optional timeout, in seconds, for the service call. A non-positive value means no timeout. If not provided, the rosbridge server will use its default value.
Returns void
- Defined in src/core/Service.ts:66

emit

emit<T extends string | symbol>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listenerCount

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

listeners

listeners<T extends string | symbol>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

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

removeListener

removeListener<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

unadvertise

unadvertise(): Promise<void>
Returns Promise<void>
- Defined in src/core/Service.ts:202

Class Service<TRequest, TResponse>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

name: string

ros: Ros

serviceType: string

Returns Service<TRequest, TResponse>

Properties

isAdvertised

name

ros

serviceType

Staticprefixed

Methods

addListener

Type Parameters

Parameters

Returns this

advertise

Parameters

Returns Promise<void>

advertiseAsync

Parameters

Returns Promise<void>

callService

Parameters

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ((...args: any[]) => 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

unadvertise

Returns Promise<void>

Settings

On This Page

`Static`prefixed