20.3.5 Interface <<textual-output-channel>>

The following syntactic bindings are exported by the library (vicare net channels).

Interface Type: <<textual-output-channel>>

Parent Type: <<channel>>

Expose the methods for all the textual output channels.

Method on <<textual-output-channel>>: <void> send-begin! this

Configure a channel to start sending a message. If this is not inactive: an assertion is raised.

Method on <<textual-output-channel>>: <non-negative-fixnum> send-end! this

Finish sending a message by flushing the underlying device and returning the total number of characters sent. If this is not in the course of sending a message: an assertion is raised.

After this function is applied to a channel: the channel itself is configured as inactive; so it is available to start sending or receiving a message.

Method on <<textual-output-channel>>: <void> flush this

Flush to the destination the data buffered in the underlying device. If this is not in the course of sending a message: an assertion is raised. If the maximum delivery time is exceeded: an exception is raised.

Method on <<textual-output-channel>>: <void> send-abort! this

Abort the current operation and reset the channel to inactive. If this is not in the course of sending a message: an assertion is raised. If some data is in the output buffer of the underlying device: it is left untouched.

Method on <<textual-output-channel>>: <void> send-message-portion! this {portion <string>}

Send a portion of output message through the given channel. If this is not in the course of sending a message: an assertion is raised. The argument portion must be a string representing the message portion. This function does not flush the underlying device.

If the current message size exceeds the maximum configured size: an exception is raised. If the maximum delivery time is exceeded: an exception is raised.

Method on <<textual-output-port>>: <non-negative-fixnum> send-full-message this {portion <string>} …

Send a full message composed of the given portion arguments; return the total number of characters sent. If this is not inactive: an assertion is raised.

If the message size exceeds the maximum configured size: an exception is raised. If the maximum delivery time is exceeded: an exception is raised.