2.2.9.2.1.9 TSG_PACKET_MSG_RESPONSE

  • Article

The TSG_PACKET_MSG_RESPONSE structure contains the response of the RDG server to the client when a message needs to be sent to the client. The value of the packetId field in TSG_PACKET MUST be set to TSG_PACKET_TYPE_MESSAGE_PACKET.

 typedef struct _TSG_PACKET_MSG_RESPONSE {
   unsigned long msgID;
   unsigned long msgType;
   long isMsgPresent;
   [switch_is(msgType)] TSG_PACKET_TYPE_MESSAGE_UNION messagePacket;
 } TSG_PACKET_MSG_RESPONSE,
  *PTSG_PACKET_MSG_RESPONSE;

msgID: This field is unused.<20> This field can be ignored.

msgType: An unsigned long specifying what type of message is being sent by the server. This MUST be one of the following values.

Value

Meaning

TSG_ASYNC_MESSAGE_CONSENT_MESSAGE

0x00000001

The server is sending a Consent Signing Message.

TSG_ASYNC_MESSAGE_SERVICE_MESSAGE

0x00000002

The server is sending an Administrative Message.

TSG_ASYNC_MESSAGE_REAUTH

0x00000003

The server expects the client to Reauthenticate.

isMsgPresent: A Boolean that indicates whether the messagePacket parameter is present or not. If the value is TRUE, then messagePacket contains valid data and can be processed. If the value is FALSE, messagePacket parameter MUST be ignored.

messagePacket: A TSG_PACKET_TYPE_MESSAGE_UNION union, as specified in section 2.2.9.2.1.9.1.