All information in the Galaxy Communicator system is stored in frames. There are a number of reserved keys which are used to pass important information between the Hub and servers, or within the Hub. This list is provided only for reference; these keys are not guaranteed to remain the constant, although every effort will be made to keep them so. The programmer should not need to refer to any of them directly.
variable name | value | description | functions |
GAL_ERROR_NUMBER_FRAME_KEY | :errno | the error number of an error | GalIO_CreateErrorFrame, GalIO_GetError, GalIO_CommDispatchFrame |
GAL_ERROR_DESCRIPTION_FRAME_KEY | :err_description | the error description | GalIO_CreateErrorFrame, GalIO_GetError |
GAL_SESSION_ID_FRAME_KEY | :session_id | the ID of the current session (used in opaque data, deprecated at toplevel) | |
GAL_TOKEN_INDEX_FRAME_KEY | :tidx | the unique index of the Hub token associated with this message; used in opaque data | |
GAL_SERVER_TOKEN_INDEX_FRAME_KEY | :server_tidx | the unique index of server-to-server subdialogues generated by the servers, which is returned to the server with the reply; used in opaque data | GalIO_CommDispatchFrame |
GAL_HUB_OPAQUE_DATA_FRAME_KEY | :hub_opaque_data | opaque data carried along by server messages for the Hub | |
GAL_SIGNATURES_FRAME_KEY | :signatures | the server message signatures reported back to the Hub during the handshake | |
GAL_SERVER_PROPERTIES_FRAME_KEY | :properties | the server properties reported back to the Hub during the handshake | |
GAL_SERVICE_TYPE_FRAME_KEY | :extra_service_types | the extra service types reported back to the Hub during the handshake | |
GAL_BROKER_CALL_ID_FRAME_KEY | :call_id | the unique "cookie" to validate broker connections | GalIO_FrameSetBrokerCallID |
GAL_ROUND_TRIP_FRAME_KEY | :reply_requested | indicates that the server wants an answer to this message, or that the Hub wants an answer to this message; used in opaque data | GalIO_DispatchViaHub |
GAL_CONNECTION_TYPE_FRAME_KEY | :conn_type | holds the connection type (broker or normal connection) during a handshake between a client and listener | |
GAL_HUB_NEW_SESSION_FRAME_KEY | :hub_new_session | indicates that the Hub should call the Builtin function new_session (deprecated) | |
GAL_RESET_SESSION_FRAME_KEY | :reset_session | indicates that the Hub should call the Builtin function new_session (in opaque data) | |
GAL_PROTOCOL_VERSION_FRAME_KEY | :protocol_version | the current version of the communication protocol the server or Hub is running, exchanged in the handshake | |
GAL_UTTERANCE_ID_FRAME_KEY | :utterance_id | ID of the current utterance | |
GAL_LOCK_MASK_FRAME_KEY | :lock_mask | value of the session lock mask; in opaque data | |
GAL_LOCK_VALUE_FRAME_KEY | :lock_value | value of the session lock value; in opaque data | GalSS_EnvSetSession |
variable name | value | description |
GAL_HUB_SESSION_USER_HUB_FRAME_KEY | :hub_session_user | stores the user for this session |
GAL_HUB_SERVER_UNAVAILABLE_HUB_FRAME_KEY | :hub_server_unavailable | indicates that the server is unavailable |
GAL_HUB_SESSION_UTTERANCE_ID_HUB_FRAME_KEY | :hub_session_utterance_id | internal storage of utterance ID |
GAL_NO_ABORT_HUB_FRAME_KEY | :no_abort | indicates that the program cannot be aborted |
GAL_SESSION_ERROR_COUNT_HUB_FRAME_KEY | :session_error_count | record of number of errors in the current session |
GAL_OPAQUE_SCRIPT_MODULE_HUB_FRAME_KEY | :hub_program_info | opaque data the scripting module maintains |
Please send comments and suggestions to:bugs-darpacomm@linus.mitre.org
Last updated December 28, 2000.
Copyright (c) 1998, 1999, 2000
The MITRE
Corporation
ALL RIGHTS RESERVED