ActionReport, ConversationID, ConvEvent, Credentials, EncryptionKey, InterfaceSpec, KeyTable, NetAddress, NB, nullID, noAddress, PartyID, PartyType, Reason, ROPE, SHHH, SmartsID, StateInConv, unencrypted, VoiceSocket ],

nullID: RefID.ID = Thrush.nullID;

none: SHHH = Thrush.unencrypted;

role: SmartsRole←NIL,

netAddress: Thrush.NetAddress←Thrush.noAddress

];

$none is used by some software to indicate that no type has yet been accommodated. See LarkOutImpl.

$interactive is ordinary "full-duplex" conversation among 2 or more parties;

$meeting is conversation involving one moderator, possibly one commentator, and n-c-1 auditors.

voiceTerminal represents a role corresponding to Lark Smarts, front or back door, or BluejaySmarts; an actual source/sink of audio information, as well as the smarts control functions.

controller represents an entity that can perform control functions, but cannot supply or accept the voice transmission protocol. Standard and only present example: FinchSmarts. Controllers generally get to hear about changes in conversations before their associated voice terminals do.

Subject, name, urgency, ... -- name is for named, meeting-style conversations.

CallUrgency: TYPE= ATOM; -- {

Priority, alertKind, ...

AlertKind: TYPE = ATOM; -- { $queryOnly, $standard=NIL, $intercom, $background, ... };

A Smarts must relay all call-placement requests through a Party it is associated with. This is because we don't trust all Smarts as much as we trust all Parties; the Parties should validate the requests. The party level, however, only concerns itself with maintaining the "truth" about the current state of all parties in a conversation, reporting state transitions to interested smarts, and storing/computing some values that smarts may be interested in. Smarts are responsible for initiating their own state transitions and in interpreting the meaning of being in one state or another.

Exceptions: 1) One smarts may advance another party into the $notified state in order to initiate a call. 2) When all parties in a conversation are in the $idle state, the party code can eliminate all the data structures associated with the conversation.

CreateConversation produces a new conversation and puts the calling party in it, in the indicated state; one can destroy the conversation only by idling onesself with respect to it, and expecting others to do the same. CreateConversation accepts other call parameters as a convenience. The conversation's creator is henceforth known to the system as the $originator of the conversation. checkConflict causes a test for front-door/back-door conflict to be made as the conversation is initiated. See PartyConflict.

Alert adds another party to the conversation, in $notified state -- this is always legal, assuming the party's not in the conversation already! The notified party is expected to advance to a further state and report it to the $originator (caller of Alert). The originator can not subsequently influence the behavior of the notified party, except by suggestion.

Advance is called by smarts to progress its own party through a call. See Thrush.StateInConv for a description of the states and their meanings. The reason/comment fields are most useful when going idle, to indicate whether it was due to some problem or just because the call is over. If bilateral is requested, an Advance to $active will fail if >1 parties are already active in the conversation, else will enter a state where additional attempts to become active will fail until the requesting party leaves active participation.

Most ThParty functions return an NB (nota bene) code. If this value is not $success, usually any other return values will be NIL, nullID, or meaningless, and the requested operation will not have been performed. The NB values indicate generally what went wrong. $stateMismatch means that some other party has changed state and the caller has not yet been informed of that. This will only be returned from functions that operate on the conversation state.

shhh: SHHH ← none,

credentials: Credentials,

state: Thrush.StateInConv←$initiating,

reason: Thrush.Reason ← NIL, -- if present, state is probably $failed (to get error signals when no conversation was ever established.)

comment: ROPE ← NIL,

convAttributes: Attributes←NIL, -- added to conversation list

partyAttributes: Attributes←NIL, -- added to own party list

checkConflict: BOOL ← FALSE

] RETURNS [ nb: NB, convEvent: Thrush.ConvEvent ];

shhh: SHHH ← none,

credentials: Credentials,

calledPartyID: PartyID←nullID,

comment: ROPE←NIL,

convAttributes: Attributes←NIL,

partyAttributes: Attributes←NIL -- initializes alerted party's list!

] RETURNS [nb: NB ];

shhh: SHHH ← none,

credentials: Credentials,

state: Thrush.StateInConv,

reportToAll: BOOL←FALSE,

reason: Thrush.Reason←NIL, -- wontSay

comment: ROPE←NIL,

convAttributes: Attributes←NIL,

partyAttributes: Attributes←NIL, -- own

bilateral: BOOL ← FALSE, -- no more than two active parties in this conversation, please, while this party is an active participant.

checkConflict: BOOL ← FALSE -- The state we are advancing to will require that the associated voice hardware be in use; disallow transitions that would make this true of two different conversations for the same party (apply to poachees, inherit by poachers?)

] RETURNS [nb: NB, convEvent: Thrush.ConvEvent ];

shhh: SHHH ← none,

report: Thrush.ActionReport, -- includes credentials (in other field) identifying the service party.

reportToAll: BOOL ← FALSE,

selfOnCompletion: BOOL←FALSE

] RETURNS [nb: NB, numReportsIssued: NAT𡤀];

Information about the conversation as a whole

convID: Thrush.ConversationID←NULL,

numParties: NAT←TRASH,

numActive: NAT←TRASH,

numIdle: NAT←TRASH,

originator: Thrush.PartyID ← TRASH,

conferenceHost: Thrush.NetAddress←TRASH,

convType: ConvType←$none, -- meeting or interactive

bilateralConv: BOOL ← FALSE, -- conversation restricted to two parties

startTime: BasicTime.GMT←TRASH,

convAttributes: Attributes←NIL, -- conversation-wide attributes

moderator: Thrush.PartyID ← 0, -- not always the originator, for named conversations

commentator: Thrush.PartyID ← 0 -- feedback channel party, for named conversations

];

A bilateral conversation is one with two active parties in it, one of which has demanded that the number not exceed two. N.B. This condition will not be set unless both parties are currently in the active state. N.B. This condition will not be set unless the ConversationInfoRec is a component of a PartyInfo returned by GetPartyInfo.

RETURNS [

shhh: SHHH ← none,

credentials: Credentials, -- partyID is owner, convID identifies conversation

name: ROPE, -- Should be unique, but this is not yet enforced; may be some use

convType: ConvType ← $meeting, -- default unregistered is $interactive

convAttributes: Attributes ← NIL, -- Permits changing the subject, etc.

accessList: AccessList ← NIL

] RETURNS [ nb: NB ];

shhh: SHHH ← none,

partyID: PartyID,

name: ROPE

] RETURNS [ nb: NB, cInfo: ConversationInfo ];

shhh: SHHH ← none,

partyID: PartyID

] RETURNS [ nb: NB, candidates: LIST OF ConversationInfo ];

Socket numbers and host names for each of the voice terminals in this conversation. All active parties are arrayed ahead of any others.

numParties: NAT𡤀,

conversationInfo: ConversationInfoRec, -- description of overall conversation

ixSelf: NAT←nullIx, -- index of own party in parties sequence

ixOther: NAT ← nullIx, -- index of some other (active, if any) party, if any

ixModerator: NAT←nullIx, -- index of moderator party

ixCommentator: NAT←nullIx, -- index of talkBack (commentator) party

ixCommSock: NAT←nullIx, -- index of party whose socket is in use as the commentator socket.

ixOriginator: NAT←nullIx, -- index of originator party in parties sequence (needed?)

parties: SEQUENCE len: NAT OF PartyInfoSpec -- and of individual parties

];

ixSelf value is meaningless if numParties = 0. ixOther value, along with all other indices # ixSelf are meaningless if numParties < 2. ixCommentator, ixCommSock values are meaningless when conversation type is not $meeting.

partyID: PartyID←nullID,

name: Thrush.ROPE←NIL, -- owner, current name, or description, see below

Call may have been intended for someone else. If not, same as partyID and name

type: Thrush.PartyType←NIL,

state: Thrush.StateInConv←$neverWas, -- of this party in the conversation

numConvs: NAT𡤀,

enabled: BOOL�LSE,

voicePath: BOOL ← FALSE, -- TRUE iff this party can participate actively in conversations

partyActive: BOOL←FALSE, -- actively involved in n-way conversation

partyEngaged: BOOL←FALSE, -- hardware in use

socket: Thrush.VoiceSocket←Thrush.noAddress, -- in1 (tx1) socket template this party's voice terminal

partyAttributes: Attributes ← NIL

];

$owner: RName of creator of this party; same as $current for telephone and individual parties; RName of trunk's owner for trunks; Idle service RName for services.

$current: Current assignment; identity of party on the other end of a $trunk, or modified service name identifying user.

$address: meaningless but same as $current for all but $trunk, where it's the phone number

$description: dolled-up version of $current, suitable for framing, including all known names and numbers, for Finch and so on.

shh: SHHH←none,

credentials: Credentials,

nameReq: NameReq←$current,

allParties: BOOL←FALSE -- IF FALSE, just calling party; else all parties, calling party first

]

RETURNS [

GetPartyInfo[nameReq: $current, allParties: FALSE] replaces GetRname.

GetPartyInfo[nameReq: $description, allParties: FALSE] replaces DescribeParty

RETURNS[nb: NB, description: Thrush.ROPE, type: Thrush.PartyType,

partner is poachee if party type is $individual, poacher if party type is $telephone, else NA

visitee and visitors are usually nonexistent, so there's no option for suppressing their values. This should probably just get subsumed into GetPartyInfo.

credentials: Credentials,

convAttributes: Attributes←NIL,

partyAttributes: Attributes←NIL -- own

] RETURNS[nb: NB];

shhh: SHHH ← none,

credentials: Credentials,

interfaceSpecPattern: Thrush.InterfaceSpec

] RETURNS[nb: NB, interfaceSpec: Thrush.InterfaceSpec];

Having registered it, the caller (service provider) must also XXXRpcControl.ExportInterface[...] the interface, under the specified instance name. interfaceSpecPattern.type should be a simple rope, not a Grapevine RName, since we don't really want Grapevine involved at all. The client can either supply an instance value or let RegisterService invent one (present BluejaySmarts produces 5 parties, but each has the same behavior, so it could use the instance invented during the registration of the first one for the rest of them.)

There can/will be only one instance/version of an interface with a given type name registered for a party at a time. New ones override old ones.

Caller should supply interfaceSpecPattern.hostHint. If it's null, an attempt will be made to produce a decent value, no guarantees (shhh=none implies call is from own host.)

NB can complain about the credentials.

shhh: SHHH ← none,

credentials: Credentials,

serviceParty: PartyID,

type: RPC.ShortROPE

] RETURNS[nb: NB, interfaceSpec: Thrush.InterfaceSpec];

shh: SHHH ← none,

credentials: Credentials,

key: Thrush.EncryptionKey,

reportNewKeys: BOOL←FALSE

]

RETURNS [ nb: NB, keyIndex: [0..17B] ];

RETURNS [

shh: SHHH ← none,

credentials: Credentials,

key: Thrush.EncryptionKey

]

RETURNS [ nb: NB ];

Parties represent participants in conversations. Depending on type, they represent:

GetParty and friends map names into parties. (Register creates new parties.) The rName is either the name of an individual (including registry), a service (e.g., "recording"), or (in the case of trunks) NIL.

partyID is the ID for one's own party -- the "self" of object-style references. This form is followed throughout this interface.

shh: SHHH←none, partyID: PartyID, rName: ROPE←NIL,

type: Thrush.PartyType←NIL

] RETURNS [nb: NB, newPartyID: PartyID];

IF nb#success, it gives some idea of what went wrong. Thrush.NB can be extended with specialized error values in cases where the caller is expected to understand more about it (when obtaining services, for instance)

IF type=NIL, it's a request for an $individual (preferably) or $telephone (otherwise).

GetParty will return one's own trunk, properly configured, if type=$telephone and no Etherphone party can be found.

shh: SHHH←none,

partyID: PartyID,

phoneNumber: Thrush.ROPE←NIL, description: ROPE←NIL

] RETURNS [nb: NB, newPartyID: PartyID];

phoneNumber is a valid extension or outside telephone number. Description is probably a name, but may not be an RName; we can use it to help the user, but not to look up anything. Unless trunkOK, number must be an internal extension representing an Etherphone user.

shh: SHHH←none,

partyID: PartyID,

feepNum: Thrush.ROPE←NIL

] RETURNS [nb: NB, newPartyID: PartyID];

FeepNum is a string of the form "*nnnnn", where "nnnnn" is a prefix of some rName, mapped with information loss into the corresponding DTMF buttons. The prefix should be long enough to be guaranteed unique within the system. This isn't at all good yet.

RETURNS [nb: NB, partyID: Thrush.PartyID];

Who do we represent when we initiate an outgoing call? After obtaining this party, it may become invalid (due to the party dropping out), so be prepared for $noSuchParty problems all along the line.

RETURNS [nb: NB];

Irrelevant except for service party. Optional function to release reservation of targetPartyID. After calling GetParty, a client is expected to engage the targetParty in a conversation fairly quickly, in human terms. The client has the exclusive right to do this for a moderate time interval, after which it's fair game again. This procedure releases that right early.

RETURNS [fullRName: ROPE, number: ROPE, homeNumber: ROPE];

fullRName is NIL if nothing found.

A Smarts implementation uses Register to create the server's identifier for the Smarts, to create the corresponding party, and to establish the necessary links between these objects and the reset of the system. <There used to be some authentication involved in this step, but for now we're trusting RPC to provide authorized identities.>

Since the server needs to be able to deal with more than one Smarts implementation, they are implemented as objects and must use RPC's object-oriented option.

Options include:

shh: SHHH←none,

Identification of party -- requires either:

Identification of smarts implementation -- requires either:

Kind of Smarts being registered, and from what host

] RETURNS [

nb: NB, credentials: Credentials ];

Verifies that the credentials are still valid, (conv can be null), or if not, which problem is the most pronounced. Can be used as basis for occasional Smarts to party polling.

nb will be noSuchSmarts or success, or something else (which implies things are confused)

RETURNS [nb: Thrush.NB];

nb=success unless something went wrong. Any parties connected to this smarts will now be available to GetParty; this smarts is an active voice smarts.

RETURNS [nb: Thrush.NB];

This smarts can no longer supply a voice connection to its parties.

shh: SHHH←none,

hostPartyID: PartyID, guestPartyID: PartyID,

guestPassword: GVBasics.Password

]

RETURNS [nb: Thrush.NB];

visitedParty is permitting visitingParty to visit. Visited party must be of type $individual or this function is not permitted. Returns $passwordNotValid either if visitingPassword = noPassword and password protection is required, or if an invalid password is supplied. A GVBasics.Password may be obtained from VoiceUtils.CurrentPassword (not CurrentPasskey!)

shh: SHHH←none,

hostPartyID: PartyID, guestPartyID: PartyID,

guestPassword: GVBasics.Password

]

RETURNS [nb: Thrush.NB];

Visitor has returned home. Password is required, under same circumstances as above, so that no one can maliciously cancel visiting. Visit implementation may choose to retain the key for this reason, although it is not strictly speaking safe to do so.

shh: SHHH←none,

guestPartyID: PartyID

]

RETURNS [nb: Thrush.NB];

Allows the visitor (the guest) to cancel the visiting arrangement.