- Source:
Members
serviceName :string
Type:
- string
- Source:
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:
isServiceServerAvailable() → {boolean}
Checks if the service is available.
- Source:
Returns:
true if the service is available.
- Type
- boolean
sendRequest(request, callback) → {undefined}
Send the request and will be notified asynchronously if receiving the repsonse.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
object | The request to be submitted. |
callback |
ResponseCallback | Thc callback function for receiving the server response. |
- Source:
- See:
Returns:
- Type
- undefined
(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:
Returns:
true if the service is available.
- Type
- Promise.<boolean>