Objeck Documentation

All Bundles

Bundle File and console I/O primitives. FileReader and FileWriter handle sequential file access; Console provides stdin/stdout operations. Included in lang.obl — no extra -lib flag needed.

Pipe

Named pipe support. For POSIX, a file backed UNIX socket. For Windows, a named pipe object.

Implements: InputStream, OutputStream

Close #

Closes the stream

method : public : Close() ~ Nil

GetName #

Gets the pipe name

method : public : GetName() ~ String

Return

Type	Description
String	pipe name

IsOpen #

Returns rather the pipe is open

method : public : IsOpen() ~ Bool

Return

Type	Description
Bool	true if pipe is open, false otherwise

New # constructor

Creates a new pipe or attaches to an existing one

New(name:String, mode:Pipe->Mode)

Parameters

Name	Type	Description
name	String	pipe path and name. For POSIX the base directory is /tmp/ for Windows \\.\pipe\
mode	Pipe->Mode	create or open pipe

Name

Type

Description

name

String

pipe path and name. For POSIX the base directory is

/tmp/

for Windows

\\.\pipe\

mode

Pipe->Mode

create or open pipe

ReadBuffer #

Reads bytes into a byte buffer

method : public : ReadBuffer(offset:Int, num:Int, buffer:Byte[]) ~ Int

Parameters

Name	Type	Description
offset	Int	destination buffer offset
num	Int	number of values to read
buffer	Byte	input buffer

Return

Type	Description
Int	number of values read

ReadBuffer #

Reads bytes into a character buffer

method : public : ReadBuffer(offset:Int, num:Int, buffer:Char[]) ~ Int

Parameters

Name	Type	Description
offset	Int	destination buffer offset
num	Int	number of values to read
buffer	Char	input buffer

Return

Type	Description
Int	number of values read

ReadByte #

Reads a byte

method : public : ReadByte() ~ Byte

Return

Type	Description
Byte	byte read

ReadLine #

Reads a string until a newline or character return is detected

method : public : ReadLine() ~ System.String

Return

Type	Description
String	character string

WriteBuffer #

Writes bytes from a buffer

method : public : WriteBuffer(offset:Int, num:Int, buffer:Byte[]) ~ Int

Parameters

Name	Type	Description
offset	Int	destination buffer offset
num	Int	number of values to write
buffer	Byte	input buffer

Return

Type	Description
Int	number of values written

WriteBuffer #

Writes characters from a buffer

method : public : WriteBuffer(offset:Int, num:Int, buffer:Char[]) ~ Int

Parameters

Name	Type	Description
offset	Int	destination buffer offset
num	Int	number of values to write
buffer	Char	input buffer

Return

Type	Description
Int	number of values written

WriteByte #

Writes a byte

method : public : WriteByte(b:Int) ~ Bool

Parameters

Name	Type	Description
b	Int	byte to write

Return

Type	Description
Bool	true if byte was written, false otherwise

WriteString #

Writes a character string

method : public : WriteString(str:System.String) ~ Nil

Parameters

Name	Type	Description
str	String	string to be written