Share via

2.2.2.4 DeleteService Message Payload

  • Article

The purpose of the DeleteService message is to allow a client to shut down a previously instantiated remote service, and the message payload contains all information needed to that end: the service handle (allocated by the CreateService message) that uniquely identifies the service to be shut down.

As the DeleteService message is a function exposed by the DSLR built-in dispenser service, it follows the same convention as would a call on an application-defined DSLR remote service call. The message tag and payload is a child of the DSLR Dispatch Request tag defined in section 2.2.1, and includes the input parameters for the DeleteService function call.

  • The client MUST NOT invoke any remote function calls (dispatch requests) after calling DeleteService.

  • DeleteService is a two-way request message, so the CallingConvention parameter in the Dispatch Request tag MUST be dslrRequest (0x00000001).

  • DeleteService is a call on the dispenser service, so the service handle parameter in the Dispatch Request tag MUST be DispenserHandle (0x00000000).

  • The function handle parameter in the Dispatch Request tag for DeleteService MUST be DeleteService (0x00000002).

The format for the DeleteService message payload (the DeleteService function's input parameters) is as follows:


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

ServiceHandle

ServiceHandle (4 bytes): An unsigned 32-bit integer. The unique service handle that identifies the service to be shut down. This service handle is allocated by the client and passed to the service through the CreateService call.

See the following section about the format of the Response payload for the DeleteService message.