Index of class methods


A
accept [Cf_sock_stream.T.listener]
Use obj#accept to accept a new connection from a remote peer.
advance [Cf_parser.cursor]
Use c#advance i to construct a new object corresponding to the new input position after reading an input symbol i.

B
bind [Cf_sock_common.T.basic]
Use self#bind sa to bind the local endpoint address of the socket to the socket address sa.

C
canget [Cf_poll.event]
Returns false if the event requires service by a polling mux before a result may be obtained with the get method.
channel [Cf_journal.basic_channel_archiver]
Returns the channel used to construct the archiver.
check [Cf_gadget.connector]
Returns true if the other end of the wire has not yet been reclaimed by the garbage collector.
close [Cf_sock_common.endpoint]
Use obj#close to close the socket.
close [Cf_sock_common.T.basic]
Use obj#close to close the socket.
code [Cf_journal.basic_prioritizer]
Returns the integer corresponding to the priority level.
code [Cf_journal.T.prioritizer]
Use p#code v to convert the priority level v to a priority code with the prioritizer p.
col [Cf_lexer.line_cursor]
Returns the col_ member.
col [Cf_lex.cursor]
Returns the col_ member.
connect [Cf_sock_stream.T.initiator]
Use obj#connect to initiate the connection to the remote address provided to the constructor.
connect [Cf_sock_dgram.T.endpoint]
Use obj#connect to associate the socket with the remote address address.
counter [Cf_lexer.line_cursor]
Returns a new counter object containing the row, column and index of the current cursor position.
counter [Cf_lex.cursor]
Returns a new counter object containing the row, column and index of the current cursor position.

D
debug [Cf_journal.basic_agent]
Use a#debug msg ... to format message text to put to the archivers at the `Debug level.
dup [Cf_sock_common.T.basic]
Use obj#dup to duplicate the socket.
dup2 [Cf_sock_common.T.basic]
Use obj#dup2 sock to duplicate the socket, overwriting the socket sock in the process.

E
emit [Cf_journal.basic_channel_archiver]
Emits each basic event e with a priority level less than `Fail to the channel c using Printf.fprintf c "%s: %s\n" e#prioritizer#tag e#message.
emit [Cf_journal.T.archiver]
Define the emit method in a subclass to archive diagnostic events into a journaling system.
enabled [Cf_journal.T.agent]
Use a#enabled v to test whether the priority code corresponding to the priority level v is preceded in the total order by the minimum priority code.
error [Cf_lexer.cursor]
This method is invoked as c#error n z in a lexer when no rule matches the input stream z after n characters.
error [Cf_journal.basic_agent]
Use a#error msg ... to format message text to put to the archivers at the `Error level.
event [Cf_journal.T.agent]
Define the private event method to construct an event object with a priority level and a message text.

F
fail [Cf_journal.basic_agent]
Use a#fail msg ... to format message text to put to the archivers at the `Fail level, and finally used to raise an Failure exception.
fd [Cf_sock_common.endpoint]
Returns the Unix.file_descr equivalent of the socket descriptor.
fd [Cf_sock_common.T.basic]
Returns the Unix.file_desc corresponding to the socket.
fini [Cf_scan_parser.scanner]
Finalize the scanning buffer and return the next unmatched input symbol.

G
get [Cf_poll.event]
Get the final result of the I/O event.
get [Cf_scan_parser.scanner]
Get the next character for the scanning buffer
get [Cf_gadget.rx]
Use rx#get f to produce a guard that receives a message on the associated wire by applying the function f to it.
getpeername [Cf_sock_stream.T.endpoint]
Use obj#getpeername to obtain the actual remote address associated with the socket.
getpeername [Cf_sock_dgram.T.endpoint]
Use obj#getpeername to obtain the actual remote address associated with the socket.
getpeername [Cf_sock_common.T.basic]
Use self#getsockname to get the remotely bound endpoint address of the socket.
getsockname [Cf_sock_stream.T.endpoint]
Use obj#getsockname to obtain the actual local address associated with the socket.
getsockname [Cf_sock_stream.T.listener]
Use obj#getsockname to obtain the actual local address associated with the socket.
getsockname [Cf_sock_stream.T.initiator]
Use obj#getsockname to obtain the actual local address associated with the socket.
getsockname [Cf_sock_dgram.T.endpoint]
Use obj#getsockname to obtain the actual local address associated with the socket.
getsockname [Cf_sock_common.T.basic]
Use self#getsockname to get the locally bound endpoint address of the socket.
getsockopt [Cf_sock_common.T.basic]
Use obj#getsockopt opt to get the value of the socket option opt.
guard [Cf_machine.initial]
A stub method that produces a guard on no gates at all.
guard [Cf_machine.state]
Implement to produce a guard for receiving events on one or more wires.

I
id [Cf_gadget.connector]
Returns a string representation of the wire end identifier.
info [Cf_journal.basic_agent]
Use a#info msg ... to format message text to put to the archivers at the `Info level.
init [Cf_scan_parser.scanner]
Initialize the scanning buffer
invalid [Cf_journal.basic_agent]
Use a#invalid msg ... to format message text to put to the archivers at the `Invalid level, and finally used to raise an Invalid_argument exception.

L
level [Cf_journal.T.event]
Returns the priority level used to construct the object.
listen [Cf_sock_stream.T.listener]
Use obj#listen n to place the socket into listening mode with a backlog queue depth of n pending connections.
load [Cf_poll.event]
Use obj#load ?q p to load the event into the collection of pending events at the polling mux p.
load_ [Cf_poll.event]
The self#load_ p method is invoked in the load method to load the specialized event into the polling mux p.

M
message [Cf_journal.T.event]
Returns the message text used to construct the object.

N
next [Cf_lexer.line_cursor]
self#next c is called in the advance method to return a new values for the row_, col_ and nlz_ members.
next [Cf_lex.cursor]
self#next c is called in the advance method to return a new values for the row_, col_ and nlz_ members.
next [Cf_machine.state]
Use obj#next to transition the state of the machine by storing obj in the state of the gadget and applying Cf_gadget.guard self#guard.
next [Cf_machine.substate]
Use obj#next to transition the state of the machine to obj.

P
position [Cf_parser.cursor]
Returns the current position.
prioritizer [Cf_journal.T.event]
Returns the prioritizer used to construct the object.
put [Cf_gadget.tx]
Use tx#put obj to schedule the message obj for deliver on the associated wire.
put [Cf_journal.T.agent]
Use this method in level-specific methods of the derived class for constructing events and putting them to archivers.

R
recv [Cf_sock_stream.T.endpoint]
Use obj#recv ?flags buf pos len to receive len octets to the string buf starting at position pos, optionally with the flags indicated by flags.
recv [Cf_sock_dgram.T.endpoint]
Use obj#recv ?flags buf pos len to receive len octets to the string buf starting at position pos from the remote address previously associated with the socket using the connect method, and optionally with the flags indicated by flags.
recv [Cf_sock_common.endpoint]
Use obj#recv ?flags buf pos len to receive len octets to the string buf starting at position pos, optionally with the flags indicated by flags.
recvfrom [Cf_sock_dgram.T.endpoint]
Use recvfrom sock buf pos len flags to receive len octets into the string buf starting at position pos on the socket sock with the flags indicated by flags.
row [Cf_lexer.line_cursor]
Returns the row_ member.
row [Cf_lex.cursor]
Returns the row_ member.

S
send [Cf_sock_stream.T.endpoint]
Use self#send ?flags buf pos len to send len octets from the string buf starting at position pos, optionally with the flags indicated by flags.
send [Cf_sock_dgram.T.endpoint]
Use self#send ?flags buf pos len to send len octets from the string buf starting at position pos to the remote address previously associated with the socket using the connect method, and optionally with the flags indicated by flags.
send [Cf_sock_common.endpoint]
Use obj#send ?flags buf pos len to send len octets from the string buf starting at position pos, optionally with the flags indicated by flags.
sendto [Cf_sock_dgram.T.endpoint]
Use self#sendto ?flags buf pos len addr to send len octets from the string buf starting at position pos to the remote address addr, and optionally with the flags indicated by flags.
service [Cf_poll.event]
The self#service p method is invoked in the cycle for the polling mux p when the event is ready to be serviced.
service [Cf_poll.file]
The method applied during the polling mux cycle whenever the file fd is ready for I/O.
setlimit [Cf_journal.T.agent]
Use a#setlimit v to set the minimum priority code to the code corresponding to the priority level v.
setsockopt [Cf_sock_common.T.basic]
Use obj#setsockopt opt v to set the value of the socket option opt.
shutdown [Cf_sock_stream.T.endpoint]
Use obj#shutdown cmd to shutdown either sending or receiving (or both) on the socket.
shutdown [Cf_sock_dgram.T.endpoint]
Use obj#shutdown cmd to shutdown either sending or receiving (or both) on the socket.
shutdown [Cf_sock_common.endpoint]
Use obj#shutdown cmd to shutdown either sending or receiving (or both) on the socket.
shutdown [Cf_sock_common.T.basic]
Use obj#shutdown cmd to shutdown either sending or receiving (or both) on the socket.
socket [Cf_sock_common.T.basic]
Returns the socket.
start [Cf_machine.initial]
Starts a new gadget process.

T
tag [Cf_journal.basic_prioritizer]
Returns the message tag corresponding to the priority level.
tag [Cf_journal.T.prioritizer]
Use p#tag v to convert the priority level v to a message tag with the prioritizer p.

U
unload [Cf_poll.event]
Use obj#unload to remove the event from the collection of pending events in a polling mux.
unload_ [Cf_poll.event]
The self#unload_ p method is invoked in the unload method to unload the specialized event from the polling mux p.

W
warn [Cf_journal.basic_agent]
Use a#warn msg ... to format message text to put to the archivers at the `Warn level.