2.2.2 Session Control (RCCOMMAND)

  • Article

Session Control (<RCCOMMAND>) messages are XML formatted messages that are used for share control, file transfer initialization, and VoIP control. They MUST be sent and received over virtual channel 71.

The format of the <RCCOMMAND> message is as follows.

Usage

 <RCCOMMAND
     NAME = "CDATA"
     FILENAME = "CDATA"
     FILESIZE = "CDATA"
     CHANNELID = "CDATA"
     INTERNALDATA = "CDATA"
     VOIPVER = "CDATA"
     VOIPGOKEY = "CDATA"
     VOIPIPLIST = "CDATA"
     EXPERTIPDATA = "CDATA"
     PROPERTY = "CDATA"
     VALUE = "CDATA"
     />

Attributes

Attribute

Type

Required

Description

NAME

CDATA

Yes

The NAME attribute of <RCCOMMAND> specifies the type of activity requested.

The following NAME value specifies file transfer commands.

Value

Meaning

"FILEXFER"

Indicates that the sender wants to begin a file transfer. This value is sent by either the client or the server.

Leading attribute whose content determines the remainder of the message.

The following NAME values specify session control messages.

Value

Meaning

"ABORTRC"

Sent by the client when an error occurs, terminating remote control.

"ACCEPTRC"

Sent by the server to accept a REMOTECONTROLSTART request from the client.

"DENIEDRC"

Sent by the server if it refuses a client remote control request due to group policy settings.

"ESCRC"

Sent by the server when it takes control back from the client by pressing the ESC key.

"REJECTRC"

Sent by the server to reject a REMOTECONTROLSTART request from the client.

"REMOTECTRLSTART"

Sent by the client to request remote control permissions from the server. This message is sent only by version 1 clients.

"REMOTECTRLEND"

Sent by the client when it no longer wants to control the server.

"TAKECONTROL"

Sent by the server when it takes control back from the client.

The following NAME values specify synchronization parameters.

Value

Meaning

"TYPINGSTART"

Indicates that the sender has begun typing a chat message. This packet type is only sent by the expert.

"EXPERTIP"

Notifies the novice of the IP address of the expert. It is only sent by the expert to the novice. This value is sent only by version 1.

"SETTINGANNOUNCE"

Indicates that the sender has a setting of a particular name (see the attribute PROPERTY) set to a particular value (see the attribute VALUE). This value is supported only by version 3.

The following NAME values specify voice-enabling commands.

Value

Meaning

"BANDWTOLOW"

Indicates that the sender would prefer to receive low-bandwidth voice communications. This packet type is sent by either the client or the server.

"BANDWTOHIGH"

Indicates that the sender would prefer to receive high-bandwidth voice communications. This packet type is sent by either the client or the server.

"DISABLEVOICE"

Indicates that the sender has disabled voice functionality. This packet type is sent by either the client or the server.

"PRESTART"

Indicates that the sender wishes to begin a voice session. This packet type is sent by either the client or the server.

"PRESTARTNO"

Indicates that the sender already has a PRESTART packet outstanding. This packet type is sent by the client or the server in response to a PRESTART packet.

"PRESTARTYES"

Indicates acceptance of a voice session request. This packet type is sent by the client or the server in response to a PRESTART packet.

"VOIPGO"

Indicates that the RTC server is ready and that the client can initiate an RTC connection. This packet type is sent by the server (if expert initiates VoIP request) or client (if novice initiates VoIP request) in response to a VOIPPREGO packet.

"VOIPGONO"

Indicates that the RTC initialization failed. This packet type is sent by the server (if expert initiates VoIP request) or client (if novice initiates VoIP request) in response to a VOIPPREGO or VOIPPREGO2 packet.

"VOIPPREGO"

Indicates completion of initial handshake and signals start of RTC connection establishment. This packet type is sent by the client (if expert initiates VoIP request) or the server (if novice initiates VoIP request) in response to a PRESTARTYES packet.

"VOIPPREGO2"

Indicates that the client will create an RTC connection to the server. This packet type is sent by the client in response to a VOIPPREGO packet.

"VOIPQNO"

Indicates that the sender has rejected a request for a voice session. This packet type is sent by the client or the server in response to a VOIPPREGO packet.

"WIZARDBAD"

Indicates that the sender has unsuccessfully used the Audio Tuning Wizard and that the receiver cannot enable voice transmission. This packet type is sent by either the client or the server.

"WIZARDGOOD"

Indicates that the sender has successfully used the Audio Tuning Wizard, and that the receiver can enable voice transmission. This packet type is sent by either the client or the server.

FILENAME

CDATA

No

The FILENAME attribute specifies the name of the file to be transferred. This attribute is used only for FILEXFER packets.

FILESIZE

CDATA

No

Specifies the file size for transfer. This attribute is used only for FILEXFER packets.

CHANNELID

CDATA

No

Specifies the virtual channel on which the file data and FILEXFERACK, FILEXFERREJECT, and FILEXFEREND packets will be transferred. This attribute MUST be used only for FILEXFER packets. The format of the virtual channel name is version dependent. For version 1, in the case where the novice started the file transfer, the name will be the IP address of the sender followed by the character ".", followed by the number of seconds since January 1, 1970. In the case where the expert started the file transfer, the name will be the characters "1000." followed by the number of seconds since January 1, 1970. For version 2 or version 3, regardless of which role started the transfer, the name will be "RA_FX".

INTERNALDATA

CDATA

No

Specifies if the file transfer request is considered as an internal data transfer. This attribute is supported only by version 3. If this attribute is missing or set to "0", the file transfer request is not considered as an internal data transfer. Any other value is interpreted as bit flags.

VOIPVER

CDATA

No

This attribute is used only for VOIPGO packets.

VOIPGOKEY

CDATA

No

Specifies that a key will be generated by the server and used by the client to create an RTC connection. This attribute is used only for VOIPGO packets.

VOIPIPLIST

CDATA

No

This attribute specifies a comma-delimited list of IP addresses on which the server will accept an RTC connection. This attribute is used only for VOIPGO packets.

EXPERTIPDATA

CDATA

No

This attribute specifies the IP address of the connecting expert. It is used only for EXPERTIP packets. This message is generated only in version 1.

PROPERTY

CDATA

No

Specifies the name of the setting that is being announced. This attribute is used only for SETTINGANNOUNCE packets. This attribute is generated only in version 3.

VALUE

CDATA

No

Specifies the value of the setting that is being announced. This attribute is used only for SETTINGANNOUNCE packets. This attribute is generated only in version 3.

Child Elements

None.

Parent Elements

None.

Element Information

Can be empty

Yes