Commit 9c549b3e authored by Per Cederqvist's avatar Per Cederqvist
Browse files

Write all types as "Foo-Bar", never "Foo-bar". Don't use tabs.

(Notation): Be explicity about how types are written.
parent 680f0e86
\input texinfo @c -*-texinfo-*- \input texinfo @c -*-texinfo-*-
@c $Id: Protocol-A.texi,v 1.27 1998/08/29 17:25:02 ceder Exp $ @c $Id: Protocol-A.texi,v 1.28 1998/08/29 18:26:50 ceder Exp $
@c %**start of header @c %**start of header
@setfilename protocol-a.info @setfilename protocol-a.info
@settitle LysKOM Protocol A @settitle LysKOM Protocol A
...@@ -205,14 +205,14 @@ Lars Aronsson documented the protocol that was in use at the time. ...@@ -205,14 +205,14 @@ Lars Aronsson documented the protocol that was in use at the time.
@item New and New Modified Structures @item New and New Modified Structures
@itemize @bullet @itemize @bullet
@item Aux-item @item Aux-Item
@item Conference @item Conference
@item Info @item Info
@item Member @item Member
@item Membership @item Membership
@item Membership-Type @item Membership-Type
@item Misc-info @item Misc-Info
@item Text-stat @item Text-Stat
@end itemize @end itemize
@item New Asynchronous Messages @item New Asynchronous Messages
...@@ -389,10 +389,17 @@ its data elements. It does not use ASN.1 because we don't know ASN.1 and ...@@ -389,10 +389,17 @@ its data elements. It does not use ASN.1 because we don't know ASN.1 and
probably wouldn't like it very much even if we did. probably wouldn't like it very much even if we did.
Data fields have been given names that start with a lower-case letter. Data fields have been given names that start with a lower-case letter.
Data types have names that start with an upper-case letter. The operator
@code{::=} defines the name to its left and @code{:} (a colon) specifies Fundamental data types have names in all-caps (such as @code{INT32} and
a type. Comments start with @code{!} (exclamation mark) and alternatives @code{ARRAY}).
are separated by a @code{|} (vertical bar.) A @code{;} (semicolon)
Derived data types have names that start with an upper-case letter. (If
the type contains more than one word, all words start with an upper-case
letter, like this: @code{Text-Stat}.) The operator @code{::=} defines
the name to its left.
Comments start with @code{!} (exclamation mark) and alternatives are
separated by a @code{|} (vertical bar.) A @code{;} (semicolon)
terminates statements in the grammar. In some specifications there are terminates statements in the grammar. In some specifications there are
literal strings. There is to be no whitespace before or after literal literal strings. There is to be no whitespace before or after literal
strings unless there is whitespace in the literal itself. strings unless there is whitespace in the literal itself.
...@@ -1332,14 +1339,14 @@ sessions. ...@@ -1332,14 +1339,14 @@ sessions.
@subsection Auxiliary Information @subsection Auxiliary Information
@tindex Aux-no @tindex Aux-No
@tindex Aux-Item @tindex Aux-Item
@tindex Aux-Item-Flags @tindex Aux-Item-Flags
@example @example
Aux-no ::= INT32; Aux-No ::= INT32;
Aux-Item ::= Aux-Item ::=
( aux-no : Aux-no; ( aux-no : Aux-No;
tag : INT32; tag : INT32;
creator : Pers-No; creator : Pers-No;
created-at : Time; created-at : Time;
...@@ -1487,13 +1494,13 @@ conferences based on their names. ...@@ -1487,13 +1494,13 @@ conferences based on their names.
@subsection Conference Status Types @subsection Conference Status Types
@tindex Garb-Nice @tindex Garb-Nice
@tindex Conference-old @tindex Conference-Old
@tindex Conference @tindex Conference
@tindex UConference @tindex UConference
@example @example
Garb-Nice ::= INT32; Garb-Nice ::= INT32;
Conference-old ::= Conference-Old ::=
( name : HOLLERITH; ( name : HOLLERITH;
type : Conf-Type; type : Conf-Type;
creation-time : Time; creation-time : Time;
...@@ -1613,8 +1620,8 @@ grammar used in this document. This is as close as it gets: ...@@ -1613,8 +1620,8 @@ grammar used in this document. This is as close as it gets:
@tindex Conf-List-Archaic @tindex Conf-List-Archaic
@example @example
Conf-List-Archaic ::= Conf-List-Archaic ::=
( conf-nos : ARRAY Conf-no; ( conf-nos : ARRAY Conf-No;
conf-types : ARRAY Conf-Type; # Sans <n>; see below conf-types : ARRAY Conf-Type; ! Sans <n>; see below
) )
@end example @end example
...@@ -1651,7 +1658,7 @@ FIXME: more text here. ...@@ -1651,7 +1658,7 @@ FIXME: more text here.
@subsection Server Information @subsection Server Information
@tindex Info @tindex Info
@tindex Info-old @tindex Info-Old
@tindex Version-Info @tindex Version-Info
@example @example
Info ::= Info ::=
...@@ -1664,7 +1671,7 @@ FIXME: more text here. ...@@ -1664,7 +1671,7 @@ FIXME: more text here.
aux-item-list : ARRAY Aux-Item; aux-item-list : ARRAY Aux-Item;
) )
Info-old ::= Info-Old ::=
( version : INT32; ( version : INT32;
conf-pres-conf : Conf-No; conf-pres-conf : Conf-No;
pers-pres-conf : Conf-No; pers-pres-conf : Conf-No;
...@@ -1681,7 +1688,7 @@ FIXME: more text here. ...@@ -1681,7 +1688,7 @@ FIXME: more text here.
@end example @end example
These data types contain information about the LysKOM server. The fields These data types contain information about the LysKOM server. The fields
of @code{Info} and @code{Info-old} are of @code{Info} and @code{Info-Old} are
@table @code @table @code
@item version @item version
...@@ -1702,7 +1709,7 @@ The conference that contains news about LysKOM. ...@@ -1702,7 +1709,7 @@ The conference that contains news about LysKOM.
The number of an article to display when LysKOM is entered or zero if The number of an article to display when LysKOM is entered or zero if
there is none. there is none.
@item aux-item-list @item aux-item-list
(Not present in @code{Info-old}.) A list of aux-items that belong to (Not present in @code{Info-Old}.) A list of aux-items that belong to
the server. the server.
@end table @end table
...@@ -1982,7 +1989,7 @@ values. ...@@ -1982,7 +1989,7 @@ values.
@subsection Article Information @subsection Article Information
@tindex Misc-Info @tindex Misc-Info
@tindex Text-Stat-old @tindex Text-Stat-Old
@tindex Text-Stat @tindex Text-Stat
@example @example
Misc-Info ::= SELECTION Misc-Info ::= SELECTION
...@@ -1999,7 +2006,7 @@ values. ...@@ -1999,7 +2006,7 @@ values.
15=bcc-recpt bcc-recipient : Text-No; 15=bcc-recpt bcc-recipient : Text-No;
) )
Text-Stat-old ::= Text-Stat-Old ::=
( creation-time : Time; ( creation-time : Time;
author : Pers-No; author : Pers-No;
no-of-lines : INTEGER; no-of-lines : INTEGER;
...@@ -3076,7 +3083,7 @@ This call always succeeds. ...@@ -3076,7 +3083,7 @@ This call always succeeds.
@example @example
get-conf-stat-older [13] (( conf-no : Conf-No; get-conf-stat-older [13] (( conf-no : Conf-No;
mask : INTEGER )) mask : INTEGER ))
-> ( Conference-old ); -> ( Conference-Old );
@end example @end example
This call retrieves the information associated with conference This call retrieves the information associated with conference
...@@ -3720,7 +3727,7 @@ except the motd-of-lyskom text without logging in first. ...@@ -3720,7 +3727,7 @@ except the motd-of-lyskom text without logging in first.
@findex get-text-stat-old @findex get-text-stat-old
@example @example
get-text-stat-old [26] ( text-no : Text-No ) get-text-stat-old [26] ( text-no : Text-No )
-> ( Text-Stat-old ); -> ( Text-Stat-Old );
@end example @end example
Get information about text number @code{text-no}. The text-stat contains Get information about text number @code{text-no}. The text-stat contains
...@@ -4305,7 +4312,7 @@ This call always succeeds ...@@ -4305,7 +4312,7 @@ This call always succeeds
@findex get-info-old @findex get-info-old
@example @example
get-info-old [36] ( ) get-info-old [36] ( )
-> ( Info-old; ); -> ( Info-Old; );
@end example @end example
This call returns the @code{Info} structure for the server This call returns the @code{Info} structure for the server
...@@ -4904,7 +4911,7 @@ The conference @code{pers-no} does not exist or is secret. ...@@ -4904,7 +4911,7 @@ The conference @code{pers-no} does not exist or is secret.
@findex get-conf-stat-old @findex get-conf-stat-old
@example @example
get-conf-stat-old [50] ( conf-no : Conf-No ) get-conf-stat-old [50] ( conf-no : Conf-No )
-> ( Conference-old ); -> ( Conference-Old );
@end example @end example
This call retrieves the conference data structure for conference number This call retrieves the conference data structure for conference number
...@@ -6138,7 +6145,7 @@ This call always succeeds. ...@@ -6138,7 +6145,7 @@ This call always succeeds.
@findex get-static-session-info @findex get-static-session-info
@example @example
get-static-session-info [84] ( session-no : Session-No ) get-static-session-info [84] ( session-no : Session-No )
-> ( Static-Session-Info ); -> ( Static-Session-Info );
@end example @end example
This call returns information about session number @code{session-no}. This call returns information about session number @code{session-no}.
...@@ -6175,9 +6182,9 @@ This call always succeeds. ...@@ -6175,9 +6182,9 @@ This call always succeeds.
@findex create-text @findex create-text
@example @example
create-text [86] (( text : HOLLERITH; create-text [86] (( text : HOLLERITH;
misc-info : ARRAY Misc-info; misc-info : ARRAY Misc-Info;
aux-items : ARRAY Aux-item; )) aux-items : ARRAY Aux-Item; ))
-> ( Text-no ); -> ( Text-No );
@end example @end example
Creates a new text with contents from @code{text} and recipients Creates a new text with contents from @code{text} and recipients
...@@ -6242,9 +6249,9 @@ One of the items looks valid but could not be created anyway. ...@@ -6242,9 +6249,9 @@ One of the items looks valid but could not be created anyway.
@findex create-anonymous-text @findex create-anonymous-text
@example @example
create-anonymous-text [87] (( text : HOLLERITH; create-anonymous-text [87] (( text : HOLLERITH;
misc-info : ARRAY Misc-info; misc-info : ARRAY Misc-Info;
aux-items : ARRAY Aux-item; )) aux-items : ARRAY Aux-Item; ))
-> ( Text-no ); -> ( Text-No );
@end example @end example
...@@ -6308,8 +6315,8 @@ One of the items looks valid but could not be created anyway. ...@@ -6308,8 +6315,8 @@ One of the items looks valid but could not be created anyway.
@example @example
create-conf [88] (( name : HOLLERITH; create-conf [88] (( name : HOLLERITH;
type : Any-Conf-Type; type : Any-Conf-Type;
aux-items : ARRAY Aux-item; )) aux-items : ARRAY Aux-Item; ))
-> ( Conf-No ); -> ( Conf-No );
@end example @end example
This call is used to create new conferences. @code{name} is the name of This call is used to create new conferences. @code{name} is the name of
...@@ -6363,8 +6370,8 @@ One of the items looks valid but could not be created anyway. ...@@ -6363,8 +6370,8 @@ One of the items looks valid but could not be created anyway.
@example @example
create-person [89] (( name : HOLLERITH; create-person [89] (( name : HOLLERITH;
passwd : HOLLERITH; passwd : HOLLERITH;
aux-items : ARRAY Aux-item; )) aux-items : ARRAY Aux-Item; ))
-> ( Pers-No ); -> ( Pers-No );
@end example @end example
...@@ -6463,9 +6470,9 @@ The conference @code{conf-no} does not exist or is secret. ...@@ -6463,9 +6470,9 @@ The conference @code{conf-no} does not exist or is secret.
@findex modify-text-info @findex modify-text-info
@example @example
modify-text-info [92] (( text : Text-no; modify-text-info [92] (( text : Text-No;
delete : ARRAY Aux-no; delete : ARRAY Aux-No;
add : ARRAY Aux-item; )) add : ARRAY Aux-Item; ))
-> ( ); -> ( );
@end example @end example
...@@ -6497,9 +6504,9 @@ One of the items in @code{add} is illegal for some reason. ...@@ -6497,9 +6504,9 @@ One of the items in @code{add} is illegal for some reason.
@findex modify-conf-info @findex modify-conf-info
@example @example
modify-conf-info [93] (( conf : Conf-no; modify-conf-info [93] (( conf : Conf-No;
delete : ARRAY Aux-no; delete : ARRAY Aux-No;
add : ARRAY Aux-item; )) add : ARRAY Aux-Item; ))
-> ( ); -> ( );
@end example @end example
...@@ -6599,8 +6606,8 @@ This call always succeeds. ...@@ -6599,8 +6606,8 @@ This call always succeeds.
@findex set-expire @findex set-expire
@example @example
set-expire [97] (( conf-no : Conf-no; set-expire [97] (( conf-no : Conf-No;
expire : Garb-nice; )) expire : Garb-Nice; ))
-> ( ); -> ( );
@end example @end example
...@@ -6877,8 +6884,8 @@ the server's restrictions will result in an error. ...@@ -6877,8 +6884,8 @@ the server's restrictions will result in an error.
@findex local-to-global @findex local-to-global
@example @example
local-to-global [103] (( conf-no : Conf-No; local-to-global [103] (( conf-no : Conf-No;
first-local-no : Local-Text-No; first-local-no : Local-Text-No;
no-of-existing-texts : INTEGER; )) no-of-existing-texts : INTEGER; ))
-> ( Text-Mapping ); -> ( Text-Mapping );
@end example @end example
...@@ -7161,7 +7168,7 @@ no matter if the response makes any sense or not. The value returned in ...@@ -7161,7 +7168,7 @@ no matter if the response makes any sense or not. The value returned in
defined below. defined below.
The meaning of @code{error-status} can be modified by any call. In The meaning of @code{error-status} can be modified by any call. In
particular the calls that deal with Misc-info lists set particular the calls that deal with Misc-Info lists set
@code{error-status} to the index of the misc item that caused the error @code{error-status} to the index of the misc item that caused the error
(if the error was caused by a misc item.) (if the error was caused by a misc item.)
...@@ -7282,7 +7289,7 @@ Attempt to create an illegal misc item. @code{error-status} contains the ...@@ -7282,7 +7289,7 @@ Attempt to create an illegal misc item. @code{error-status} contains the
index of the illegal item. index of the illegal item.
@item illegal-info-type (26) @item illegal-info-type (26)
Attempt to use a Misc-info type that the server knows nothing about. Attempt to use a Misc-Info type that the server knows nothing about.
@code{error-status} is undefined. @code{error-status} is undefined.
@item already-recipient (27) @item already-recipient (27)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment