class IpcObject

Provides an interface to Unix SysV style shared memory

Description

This class can be used to provide a means of accessing SysV style shared memory areas for interprocess communication. As well as allowing Ferite processes to communicate with each other, it can also be used to communicate with any other applications which use SysV style shared memory.

class attributes [NB. Highlighted attributes are static members] connect() - Connects to a shared memory segment disconnect() - Disconnects from a shared memory segment and possibly deletes it write() - Writes a message string to the shared memory segment read() - Reads a string from the shared memory segment

Functions

function connect Connects to a shared memory segment Declaration:     native function connect( string file ) Description: This function tries to connect to the specified shm key. If it does not exist, it will try to create it. If an error occurs, an exception is thrown (FIXME: we should really return true or false here, not throw an exception). Parameters:     Parameter #1: string file - The name of the file to attach the shm segment to.

function disconnect Disconnects from a shared memory segment and possibly deletes it Declaration:     native function disconnect( ) Description: This function disconnects the object from its shared memory segment. If no other process is connected to the segment it will be deleted.

function write Writes a message string to the shared memory segment Declaration:     native function write( string msg ) Parameters:     Parameter #1: string msg - The message string to write to the shared memory segment

function read Reads a string from the shared memory segment Declaration:     native function read( ) Returns:     A string containing the data which was read from the segment

Automatically generated at 8:45pm, Wednesday 08 January 2003 by feritedoc.