Commit 9735659f authored by Per Cederqvist's avatar Per Cederqvist
Browse files

(Mapping Local to Global Text Numbers): Renamed the field

	"later-texts-exists" in "Text-Mapping" to "more-texts-exists",
	so that it is useful for the new requests defined below.
	Updated the descriptions of some fields for the same purpose.
(local-to-global): Added a link to local-to-global-reverse.
(map-created-texts): Added a link to map-created-texts-reverse.
(set-connection-time-format): Added a missing protocol number.
(local-to-global-reverse): New request.
(map-created-texts-reverse): New request.
parent 83aa417b
......@@ -1989,7 +1989,7 @@ actually transmitted. See also the example in @ref{lookup-name}.
Text-Mapping ::=
( range-begin : @lt{Local-Text-No};
range-end : @lt{Local-Text-No};
later-texts-exists : @lt{BOOL};
more-texts-exists : @lt{BOOL};
block : @lt{Local-To-Global-Block};
)
......@@ -2014,24 +2014,32 @@ information in a @type{Text-Mapping}.
@table @field
@item range-begin
The first local text number that the client asked about.
The first local text number that the @type{Text-Mapping} says anything
about.
@item range-end
The first local text number that the reply doesn't say anything about.
This @type{Text-Mapping} tells the client about all existing texts from
@field{range-begin} to (but not including) @field{range-end}.
@item later-texts-exists
@item more-texts-exists
This is true if there are more texts in the conference after this
block.
block. If a request such as @reqlink{local-to-global-reverse} which
searches backwards, this will instead be true if there are more texts
before this block.
@item block
The block can be sent i two formats. The server is free to choose which
format to use as it pleases; clients must be prepared for any of them.
@itemize @bullet
@item
The @dfn{sparse} format is useful when many local text number no longer
exists. It starts with a @code{0} that indicates that the sparse format
is used, and is followed by an array of @type{Text-Number-Pair}. The
array will always be sorted so that @field{local-number} always
increases.
@item
The @dfn{dense} format is good when most of the local text numbers
exist. It starts with a @code{1} that indicates that the dense format
......@@ -2041,6 +2049,7 @@ The local text number @field{first-local-no} corresponds to the first
@type{Text-No} in the array, @field{first-local-no} + 1 corresponds to
the second entry in the array, and so on. The array contains a zero to
indicate that a certain local text number doesn't exist.
@end itemize
@end table
......@@ -3142,6 +3151,8 @@ their current status.
* get-scheduling:: e Get client priority information (118)
* set-scheduling:: e Alter client priority (119)
* set-connection-time-format:: r Use UTC or local timezone of server? (120)
* local-to-global-reverse:: r Map local text numbers to global ones (121)
* map-created-texts-reverse:: r Map texts created by a person to global (122)
@end menu
@ifnottex
......@@ -7883,6 +7894,9 @@ texts the client wants information about. Legal values for
The server will return a sparse or dense Text-Mapping depending on the
how many deleted texts there are after @rarg{first-local-no}.
The @reqlink{local-to-global-reverse} request can be useful if you
want to traverse the mapping from higher to lower numbers.
@reqexample
@example
1 103 93 1 5
......@@ -7979,6 +7993,9 @@ part of that mapping.
More information and examples may be found in @ref{local-to-global}.
The @reqlink{map-created-texts-reverse} request can be useful if you
want to traverse the mapping from higher to lower numbers.
@subheading Error codes
@table @errorcode
......@@ -8006,7 +8023,6 @@ ever existed in the conference.
The conference exists, but the client is not allowed to retrieve
information about the texts in the conference.
@end table
@node set-keep-commented
......@@ -8690,7 +8706,7 @@ different priorities.
@node set-connection-time-format
@section set-connection-time-format [120] (Recommended)
@section set-connection-time-format [120] (11) (Recommended)
@findex set-connection-time-format
@example
......@@ -8720,6 +8736,101 @@ The @rarg{use-utc} argument must be 0 or 1.
@end table
@node local-to-global-reverse
@section local-to-global-reverse [121] (11) Recommended
@findex local-to-global-reverse
@example
local-to-global-reverse [121] (( conf-no : @lt{Conf-No};
local-no-ceiling : @lt{Local-Text-No};
no-of-existing-texts : @lt{INT32} ))
-> ( @lt{Text-Mapping} );
@end example
This call retrieves information that makes it possible to convert
@rarg{no-of-existing-texts} existing local text numbers smaller than
@rarg{local-no-ceiling} to global text numbers, provided that there
are that many local texts smaller than @rarg{local-no-ceiling}.
In other words, this request is just link @reqlink{local-to-global},
but it searches backwards in the mapping.
The @rarg{conf-no} parameter specifies which conference to look up
local numbers in. @rarg{local-no-ceiling} is the first number that
the client is not interested in. @rarg{no-of-existing-texts} is the
maximum number of texts the client wants information about. Legal
values for @rarg{no-of-existing-texts} are 1-255 (inclusive).
The server will return a sparse or dense Text-Mapping depending on the
how many deleted texts there are before @rarg{local-no-ceiling}.
As a special case, if @rarg{local-no-ceiling} is 0, information will
be returned about the @rarg{no-of-existing-texts} highest-numbered
texts.
@subheading Error codes
@table @errorcode
@item login-first
Login required before issuing this call.
@item long-array
@rarg{no-of-existing-texts} was larger than 255.
@item conf-zero
@rarg{conf-no} was set to 0.
@item undef-conf
The conference does not exist, or the client is not allowed to know that
it exists.
@item access-denied
The conference exists, but the client is not allowed to retrieve
information about the texts in the conference.
@end table
@node map-created-texts-reverse
@section map-created-texts-reverse [122] (11) Recommended
@findex map-created-texts-reverse
@example
map-created-texts-reverse [122] (( author : @lt{Pers-No};
local-no-ceiling : @lt{Local-Text-No};
no-of-existing-texts : @lt{INT32} ))
-> ( @lt{Text-Mapping} );
@end example
Return text numbers for existing texts that @rarg{author} has written.
This is just like @reqlink{map-created-texts}, but searches in the
other direction. (Compare with @reqlink{local-to-global-reverse}.)
As a special case, if @rarg{local-no-ceiling} is 0, information will
be returned about the last @rarg{no-of-existing-texts} texts.
@subheading Error codes
@table @errorcode
@item login-first
Login required before issuing this call.
@item long-array
@rarg{no-of-existing-texts} was larger than 255.
@item conf-zero
@rarg{author} was set to 0.
@item undef-pers
The conference does not exist, or the client is not allowed to know that
it exists.
@item access-denied
The conference exists, but the client is not allowed to retrieve
information about the texts in the conference.
@end table
@node Asynchronous Messages
......
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