1.150.2 Send methods

stream ->append: data=char_array

Send data to stream. The current implementation flushes the data automatically. Future releases may provide input buffering. See also stream->newline, stream->append_line and stream->format.

stream ->close_output:

Close output section of stream.

stream ->close_input:

Closes the associated file-descriptor -rdfd/-wrfd and deallocates the input buffering.

stream ->end_of_file:

Sent by the system when end-of-file is reached on the input. The default implementation just succeeds. May be redefined.

stream ->initialise: rfd=[int], wfd=[int], input_message=[code], record_separator=[regex|int]

Creates a stream object from the following arguments:

• rfd [int] C-file-descriptor number for input. When left @default, this will be @nil, indicating input should not be monitored.
• wfd [int] C-file-descriptor number for output. When left @default this will be @nil, indicating the stream cannot be written to.
• input_message [code object] Code object for handling input. See stream<-input_message.
• record_separator [regex object] Regular expression to split input stream into logical records. The default is’\n’, splitting the input into physical lines. See stream<-record_separator.

  Class stream is designed to share code between class socket and class process. It may be used for other interaction, but all such application of this class is as yet unsupported.

stream ->input: fd=[int]*

Enable input from file-descriptor. Assigns -rdfd and initialises input synchronisation with the Window System.

stream ->unlink:

Closes the stream. See also stream->close_input and stream->close_output.

stream ->wait:

Dispatches input events until the input is closed after reading end-of-file.

stream ->write_as_file: at=[int], text=char_array

This method allows pce_open/3 to open a socket in append mode, using Prolog's stream primitives to send data to an XPCE stream. For example:

open(Socket, append, Stream),
format(Socket, 'Hello World~n', []),
close(Stream).

Note: streams cannot be opened in mode write as they lack the required source_sink->truncate_as_file method.