WsfControlMessage

WsfControlMessage inherits WsfMessage

Construction: WsfControlMessage newObj = WsfControlMessage();
Clone: WsfControlMessage newObj = WsfControlMessage(other);

Methods

string Function()

Return the command function.

void SetFunction(string aFunction)

Set the function of the message.

Note

This function is equivalent to setting the message subtype.

WsfTrackId RequestId()

Return the track Id of the current request.

void SetRequestId(WsfTrackId aTrackId)

Set request to the given track Id.

string Resource()

Return the name of the resource that is associated with the command. A command may or may not have an associated resource depending on its function. The return value will be an empty string if there is no associated resource.

void SetResource(string aResource)

Set the resource to be associated with the message

WsfTrack Track()

Return the track that is associated with the command. A command may or may not have an associated track depending on its function. The return value will have a track Id that is null (Track().TrackId().IsNull() will be true) if there is no associated track.

void SetTrack(WsfTrack aTrack)

Set the track to be associated with the message.

WsfRoute Route()

Return the route that is associated with the command. A command may or may not have an associated route depending on its function.

void SetRoute(WsfRoute aRoute)
void SetRoute(string aRouteName)

Set the specified route to be associated with the message.