Oracle in a Nutshell

Calls

FUNCTION DBMS_PIPE.CREATE_PIPE (pipename IN VARCHAR2, maxpipesize IN INTEGER DEFAULT 8192, private IN BOOLEAN DEFAULT TRUE) RETURN INTEGER;

Creates a pipe identified by pipename with maximum size maxpipesize and returns 0. When private is FALSE, the pipe is publicly accessible.

FUNCTION DBMS_PIPE.NEXT_ITEM_TYPE RETURN INTEGER;

Returns an integer identifying the datatype of the next item in the session message buffer.

PROCEDURE DBMS_PIPE.PACK_MESSAGE (item IN {VARCHAR2 | NUMBER | DATE});

Packs item into the session message buffer.

PROCEDURE DBMS_PIPE.PACK_MESSAGE_RAW (item IN RAW);

Packs the raw data in item into the session message buffer.

PROCEDURE DBMS_PIPE.PACK_MESSAGE_ROWID (item IN ROWID);

Packs the ROWID data in item into the session message buffer.

PROCEDURE DBMS_PIPE.PURGE (pipename IN VARCHAR2);

Purges all messages from pipename.

FUNCTION DBMS_PIPE.RECEIVE_MESSAGE (pipename IN VARCHAR2, timeout IN INTEGER DEFAULT MAXWAIT) RETURN INTEGER;

Receives a message from pipename into the session message buffer, waiting for up to timeout seconds for successful completion. Returns 0 for success and 1 for timeout.

FUNCTION DBMS_PIPE.REMOVE_PIPE (pipename IN VARCHAR2) RETURN INTEGER;

Removes pipename and frees its memory back to the shared pool, returning 0.

PROCEDURE DBMS_PIPE.RESET_BUFFER;

Resets the session message buffer’s pack and unpack indicators, effectively discarding all contents.

FUNCTION DBMS_PIPE.SEND_MESSAGE (pipename IN VARCHAR2, timeout IN INTEGER DEFAULT ...