ServiceServerBase QML Type

Abstract base for all generated ROS 2 service server types. More...

• List of all members, including inherited members

Properties

• active : bool
• handler : var

Detailed Description

ServiceServerBase is not creatable directly. Use a generated service server type such as TriggerServiceServer from QtRos2.StdSrvs.

Property Documentation

active : bool

true while the service is created and advertised on topic.

handler : var

A JavaScript function invoked (on the GUI thread) for every incoming request: (request, reply) => response.

The handler may respond in one of two ways:

• synchronously — return the response value. For services with a multi-field response, return an object with the response fields, e.g. ({ success: true, message: "ok" }). For services with an empty response, return any value other than undefined to acknowledge the request.
• deferred — return undefined (i.e. no return statement) and later call reply.send(response) when the work is done. Use this for requests that take time to complete.

Setting a handler is optional: generated server types also offer a declarative response property that answers each request with its current (bindable) value. A callable handler takes precedence over the response property. If neither is set (or the handler throws), a default-constructed response is sent so callers do not block indefinitely.