Index of values


A
add [Data.Map]
add [Server.Data.Map]
any [Syntax]
any [Server.Syntax]
append [Jbuffer]
array [Syntax]
array [Server.Syntax]

B
boolean [Syntax]
boolean [Server.Syntax]
bprintf [Jbuffer]
Prints into the buffer formatter.

C
chapter [Doc]
chapter [Server.Doc]
clear [Data.Index]
Clear index tables.
clear [Server.Data.Index]
Clear index tables.
column [States]
Populate an array model with a new field.
column [Server.States]
Populate an array model with a new field.
contents [Jbuffer]
Flushes the buffer and returns its JSON enoding.
create [Kernel_ast.Marker]
Memoized unique identifier.
create [Main]
Run a server with the provided low-level network primitives to actually exchange data.
create [Jbuffer]
Create a formatter with ~indent maximum indentation and ~margin right-margin.
create [Server.Kernel_ast.Marker]
Memoized unique identifier.

D
data [Syntax]
data [Server.Syntax]
default [Data.Record.S]
default [Server.Data.Record.S]
define [Syntax]
Syntactic definition: LEFT := RIGHT
define [Server.Syntax]
Syntactic definition: LEFT := RIGHT
descr [Data.Info]
descr [Server.Data.Info]
dictionary [Request]
Register a GET request dictionary.<name> to retrieve all tags registered in the dictionary.
dictionary [Data.Enum]
Creates an opened, empty dictionary.
dictionary [Server.Request]
Register a GET request dictionary.<name> to retrieve all tags registered in the dictionary.
dictionary [Server.Data.Enum]
Creates an opened, empty dictionary.
dump [Doc]
Dumps all published pages of documentations.
dump [Server.Doc]
Dumps all published pages of documentations.

E
emit [Request]
Emit the signal to the client.
emit [Main]
Emit the server signal to the client.
emit [Server.Request]
Emit the signal to the client.
empty [Data.Map]
empty [Server.Data.Map]
exec [Main]
extends [Data.Enum]
Publish a new instance in the documentation.
extends [Server.Data.Enum]
Publish a new instance in the documentation.

F
failure [Data]
failure [Server.Data]
failure_from_type_error [Data]
failure_from_type_error [Server.Data]
field [Data.Record]
Adds a field to an opened record.
field [Server.Data.Record]
Adds a field to an opened record.
fields [Syntax]
Builds a table with fields description.
fields [Server.Syntax]
Builds a table with fields description.
find [Main]
find [Data.Map]
find [Data.Index]
find [Server.Data.Map]
find [Server.Data.Index]
flush [Jbuffer]
format [Jbuffer]
All-in-one formatter.
formatter [Jbuffer]
The underlying formatter of a buffer.
fprintf [Jbuffer]
Prints back a JSON encoding into the provided formatter.

G
get [Data.Index]
get [Data.Record.S]
get [Server.Data.Index]
get [Server.Data.Record.S]
get_function_name [Parameter_sig.String]
returns the given argument only if it is a valid function name (see Parameter_customize.get_c_ified_functions for more information), and abort otherwise.
get_plain_string [Parameter_sig.String]
always return the argument, even if the argument is not a function name.
get_possible_values [Parameter_sig.String]
What are the acceptable values for this parameter.
get_range [Parameter_sig.Int]
What is the possible range of values for this parameter.

H
has [Data.Record.S]
has [Server.Data.Record.S]
href [Doc]
href [Server.Doc]

I
id [Data.IdentifiedType]
id [Server.Data.IdentifiedType]
ident [Syntax]
ident [Server.Syntax]
incr [Parameter_sig.Int]
Increment the integer.
instance [Data.Enum]
Returns the tag for a value associated with the given prefix.
instance [Server.Data.Enum]
Returns the tag for a value associated with the given prefix.
int [Syntax]
int [Server.Syntax]

K
kill [Main]
Kill the currently running request by raising an exception.

L
lookup [Kernel_ast.Marker]
Get back the localizable, if any.
lookup [Server.Kernel_ast.Marker]
Get back the localizable, if any.

M
model [States]
Creates an empty array model.
model [Server.States]
Creates an empty array model.

N
name [Data.Info]
name [Data.Enum]
name [Server.Data.Info]
name [Server.Data.Enum]
number [Syntax]
number [Server.Syntax]

O
of_json [Request.Input]
of_json [Data.S]
of_json [Server.Request.Input]
of_json [Server.Data.S]
off [Parameter_sig.Bool]
Set the boolean to false.
on [Main]
Register a callback to listen for server activity.
on [Parameter_sig.Bool]
Set the boolean to true.
on_signal [Request]
Callback invoked each time the client is starting or stopping to listen to the given signal.
on_signal [Main]
Register a callback on signal listening.
on_signal [Server.Request]
Callback invoked each time the client is starting or stopping to listen to the given signal.
option [Data.Record]
Adds a optional field to an opened record.
option [Syntax]
option [Server.Data.Record]
Adds a optional field to an opened record.
option [Server.Syntax]

P
page [Data.Info]
page [Data.Enum]
page [Data]
Documentation page for general purpose data types.
page [Doc]
Obtain the given page in the server documentation.
page [Server.Data.Info]
page [Server.Data.Enum]
page [Server.Data]
Documentation page for general purpose data types.
page [Server.Doc]
Obtain the given page in the server documentation.
param [Request]
Named input parameter.
param [Server.Request]
Named input parameter.
param_opt [Request]
Named optional input parameter.
param_opt [Server.Request]
Named optional input parameter.
path [Doc]
path [Server.Doc]
pop_tag [Jbuffer]
pp_kind [Main]
prefix [Data.Enum]
Register a new prefix tag in the dictionary.
prefix [Server.Data.Enum]
Register a new prefix tag in the dictionary.
pretty [Data]
pretty [Server.Data]
publish [Data.Enum]
Publish the dictionary.
publish [Data.Record]
Publish and close an opened record.
publish [Syntax]
The provided synopsis must be very short, to fit in one line.
publish [Doc]
Adds a section in the corresponding page.
publish [Server.Data.Enum]
Publish the dictionary.
publish [Server.Data.Record]
Publish and close an opened record.
publish [Server.Syntax]
The provided synopsis must be very short, to fit in one line.
publish [Server.Doc]
Adds a section in the corresponding page.
push_tag [Jbuffer]

R
record [Syntax]
record [Server.Syntax]
register [Request]
Register a simple request of type (a -> b).
register [Main]
register [Server.Request]
Register a simple request of type (a -> b).
register_array [States]
Register everything necessary to synchronize an array with the client: Signal <name>.sig is emitted on array updates;, GET Request <name>.fetch is registered to get updates;, GET Request <name>.reload is registered to trigger a full reload. The ~key parameter is used to identify array entries, and used to fill the reserved column "id" of entries.
register_array [Server.States]
Register everything necessary to synchronize an array with the client: Signal <name>.sig is emitted on array updates;, GET Request <name>.fetch is registered to get updates;, GET Request <name>.reload is registered to trigger a full reload. The ~key parameter is used to identify array entries, and used to fill the reserved column "id" of entries.
register_propkind [Kernel_properties]
Documentation of ACSL extensions for propkind server data.
register_propkind [Server.Kernel_properties]
Documentation of ACSL extensions for propkind server data.
register_sig [Request]
Register the request JSON processing function.
register_sig [Server.Request]
Register the request JSON processing function.
register_state [States]
Register a (projectified) state and generates the associated signal and requests: Signal <name>.sig is emitted on value updates;, GET Request <name>.get returns the current value;, SET Request <name>.set modifies the server value. If provided, the ~add_hook option is used to register a hook to notify the server of value updates.
register_state [Server.States]
Register a (projectified) state and generates the associated signal and requests: Signal <name>.sig is emitted on value updates;, GET Request <name>.get returns the current value;, SET Request <name>.set modifies the server value. If provided, the ~add_hook option is used to register a hook to notify the server of value updates.
register_value [States]
Register a (projectified) value and generates the associated signal and request: Signal <name>.sig is emitted on value updates;, GET Request <name>.get returns the current value. If provided, the ~add_hook option is used to register a hook to notify the server of value updates.
register_value [Server.States]
Register a (projectified) value and generates the associated signal and request: Signal <name>.sig is emitted on value updates;, GET Request <name>.get returns the current value. If provided, the ~add_hook option is used to register a hook to notify the server of value updates.
reload [Kernel_properties]
Trigger a full reload for the table of property status.
reload [States]
Mark the array to be fully reloaded.
reload [Server.Kernel_properties]
Trigger a full reload for the table of property status.
reload [Server.States]
Mark the array to be fully reloaded.
remove [States]
Mark an array entry as removed.
remove [Server.States]
Mark an array entry as removed.
result [Request]
Named output parameter.
result [Server.Request]
Named output parameter.
result_opt [Request]
Named optional output parameter.
result_opt [Server.Request]
Named optional output parameter.
run [Main]
Run the server forever.

S
set [Data.Record.S]
set [Server.Data.Record.S]
set_possible_values [Parameter_sig.String]
Set what are the acceptable values for this parameter.
set_range [Parameter_sig.Int]
Set what is the possible range of values for this parameter.
signal [States]
Get the signal associated with the array.
signal [Request]
Register a server signal.
signal [Main]
signal [Server.States]
Get the signal associated with the array.
signal [Server.Request]
Register a server signal.
signature [Request]
Create an opened request signature.
signature [Data.Record]
Create a new, opened record type.
signature [Server.Request]
Create an opened request signature.
signature [Server.Data.Record]
Create a new, opened record type.
start [Main]
Start the server in background.
stop [Main]
Stop the server if it is running in background.
string [Syntax]
string [Server.Syntax]
string_of_kind [Main]
syntax [Request.Output]
syntax [Request.Input]
syntax [Data.Enum]
syntax [Data.S]
readable description of the JSON format
syntax [Server.Request.Output]
syntax [Server.Request.Input]
syntax [Server.Data.Enum]
syntax [Server.Data.S]
readable description of the JSON format

T
tag [Data.Enum]
Register a new tag in the dictionary.
tag [Syntax]
tag [Server.Data.Enum]
Register a new tag in the dictionary.
tag [Server.Syntax]
tag_name [Data.Enum]
tag_name [Server.Data.Enum]
tags [Data.Enum]
Obtain all the tags registered in the dictionary so far.
tags [Syntax]
Builds a table with tags description.
tags [Server.Data.Enum]
Obtain all the tags registered in the dictionary so far.
tags [Server.Syntax]
Builds a table with tags description.
text [Syntax]
text [Server.Syntax]
to_json [Request.Output]
to_json [Data.S]
to_json [Jbuffer]
All-in-one formatter.
to_json [Server.Request.Output]
to_json [Server.Data.S]
tuple [Syntax]
tuple [Server.Syntax]

U
union [Syntax]
union [Server.Syntax]
unit [Syntax]
unit [Server.Syntax]
update [States]
Mark an array entry as updated.
update [Server.States]
Mark an array entry as updated.

W
with_unfold_precond [Printer_tag.S_pp]
wkind [Server_parameters]
Inconsistent category warning
wname [Server_parameters]
Invalid name warning
wpage [Server_parameters]
Inconsistent page warning