ProtocolUtilities

final class ProtocolUtilities

Collection of helper methods used to fulfill the introspection protocol.

Author

jwienke

Fields

BASE_SCOPE

public static final Scope BASE_SCOPE

Base scope for the whole introspection.

ECHO_RPC_METHOD_NAME

public static final String ECHO_RPC_METHOD_NAME

Name of the RPC server method for echoing back timing information to a caller.

HOST_SCOPE

public static final Scope HOST_SCOPE

Scope for host-related communication.

PARTICIPANT_SCOPE

public static final Scope PARTICIPANT_SCOPE

Scope for participant-related communication.

PING_EVENT_DATA

public static final String PING_EVENT_DATA

Data to send or expect in a ping event.

PONG_EVENT_DATA

public static final String PONG_EVENT_DATA

Data to send or expect in a pong event.

REQUEST_METHOD_NAME

public static final String REQUEST_METHOD_NAME

rsb.Event.getMethod() entry to expect on a request for a specific participant.

REQUEST_RECEIVE_USER_TIME

public static final String REQUEST_RECEIVE_USER_TIME

User timestamp name to echo back the receive time.

REQUEST_SEND_USER_TIME

public static final String REQUEST_SEND_USER_TIME

User timestamp name to echo back the send time.

SURVEY_METHOD_NAME

public static final String SURVEY_METHOD_NAME

rsb.Event.getMethod() entry to expect on a participant survey request.

Methods

isSpecificParticipantScope

public static boolean isSpecificParticipantScope(Scope scope)

Tests whether the scope formally can be interpreted as a scope for for a specific participant.

Parameters

scope – the scope to test

Returns

true if the scope has sufficient components to be the designator for a specific participant

participantIdFromScope

public static ParticipantId participantIdFromScope(Scope scope)

Extracts a ParticipantId from a scope designating a specific participant.

Parameters

scope – the scope to parse

Throws

IllegalArgumentException – scope does not contain a valid id

Returns

the parsed ParticipantId

participantScope

public static Scope participantScope(ParticipantInfo participant)

Creates a scope to send data messages on that regard a specific participant.

Parameters

participant – the participant to create the scope for

Returns

a scope related to the participant, subscope of PARTICIPANT_SCOPE.