JSDoc: Class: Client

Source:

lib/client.js, line 78

Members

loggerName

Get the logger name for this client.

Source:

lib/client.js, line 379

serviceName :string

Type:

string

Source:

lib/client.js, line 345

willValidateRequest :boolean

Whether requests will be validated before sending.

Type:

boolean

Source:

lib/client.js, line 95

willValidateRequest

Enable or disable request validation for this client.

Source:

lib/client.js, line 103

Methods

configureIntrospection(clock, qos, introspectionState)

Configure introspection.

Parameters:

Name	Type	Description
`clock`	Clock	Clock to use for service event timestamps
`qos`	QoS	QoSProfile for the service event publisher
`introspectionState`	ServiceIntrospectionState	State to set introspection to

Source:

lib/client.js, line 355

isServiceServerAvailable() → {boolean}

Checks if the service is available.

Source:

lib/client.js, line 299

Returns:

true if the service is available.

Type: boolean

sendRequest(request, callback, optionsopt) → {undefined}

Send the request and will be notified asynchronously if receiving the response.

Parameters:

Name Type Attributes Description

request object The request to be submitted.

callback ResponseCallback Thc callback function for receiving the server response.

options

object

Send options

Properties

Name	Type	Attributes	Description
`validate`	boolean	<optional>	Override validateRequests setting for this call

Source:

lib/client.js, line 139

See:

ResponseCallback

Throws:

If validation is enabled and request is invalid
Type MessageValidationError

Returns:

Type: undefined

sendRequestAsync(request, optionsopt) → {Promise.<object>}

Send the request and return a Promise that resolves with the response.

Parameters:

Name Type Attributes Description

request object The request to be submitted.

options

object

Optional parameters for the request.

Properties

Name	Type	Attributes	Description
`timeout`	number	<optional>	Timeout in milliseconds for the request.
`signal`	AbortSignal	<optional>	AbortSignal to cancel the request.
`validate`	boolean	<optional>	Override validateRequests setting for this call

Source:

lib/client.js, line 184

Throws:

If the request times out (when options.timeout is exceeded).

Type

module:rclnodejs.TimeoutError
If the request is manually aborted (via options.signal).

Type

module:rclnodejs.AbortError
If validation is enabled and request is invalid.

Type

module:rclnodejs.MessageValidationError
If the request fails for other reasons.

Type

Error

Returns:

Promise that resolves with the service response.

Type: Promise.<object>

setValidation(options)

Set validation options for this client.

Parameters:

Name Type Description

options

object

Validation options

Properties

Name	Type	Attributes	Default	Description
`strict`	boolean	<optional>	true	Throw on unknown fields
`checkTypes`	boolean	<optional>	true	Validate field types

Source:

lib/client.js, line 113

(async) waitForService(timeout) → {Promise.<boolean>}

Wait until the service server is available or a timeout is reached. This function polls for the service state so it may not return as soon as the service is available.

Parameters:

Name	Type	Description
`timeout`	number	The maximum amount of time to wait for, if timeout is `undefined` or `< 0`, this will wait indefinitely.

Source:

lib/client.js, line 311

Returns:

true if the service is available.

Type: Promise.<boolean>