Terminology
General naming conventions
- Classes and data types are named with medial capitals, starting with capital letters, e.g. "CRSocket".
- Class instances (objects) and variables are named with medial capitals, starting with lowercase letters, e.g. "crSocket".
- Server resource are named with lowercase letters only, e.g. "eventsource".
Core terms
- accessToken
- A string which identifies the current user, composed and formatted according to an arbitrary security standard.
- appId
- A string identifying a crSocket app, e.g.
commtest
or mathtrials
.
- clientId
-
A string which identifie a CRSocket client processe with a particular appId and clientRole running within a particular browserEngine.
- clientRole
- The role of a given crSocket client: either
controller
or responder
.
- crEvent
- A PHP/JavaScript CREvent object that can be transmitted between crSocket clients.
- crSocket
- A CRSocket JavaScript object.
- CRSocket app
- A pair of controller/responder clients designed to communicate with each other.
- CRSocket client
- An active web app process that is able to communicate with a partnerClient by means of a crSocket.
- CRSocket metaState
- A named set of crSocket states with some well-defined common properties.
- CRSocket state
- The current state of a crSocket.
- partnerClient
-
The crSocket client with which a client is currently communicating.
Only clients with matching appIds and complementary clientRoles can interact as partners. A given client can only be assigned to one partnerClient at a time.
- partnerClientId
- The clientId of the crSocket client currently assigned as partnerClient.