com.integpg.system

Class MessagePump

java.lang.Object

com.integpg.system.MessagePump

public class MessagePump
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	SM_GCRUN SM_GCRUN
static int	SM_PIPECLOSE SM_PIPECLOSE
static int	SM_PIPEOPEN SM_PIPEOPEN
static int	SM_PROBE SM_PROBE
static int	SM_PROTCMDMSG SM_PROTCMDMSG
static int	SM_PROTCMDRESP SM_PROTCMDRESP
static int	SM_PWRSUPP SM_PWRSUPP
static int	SM_REGUPDATE SM_REGUPDATE
static int	SM_SHUTDOWN SM_SHUTDOWN
static int	SM_WATCHDOG SM_WATCHDOG
static int	SM_WEBSHUTDOWN SM_WEBSHUTDOWN
static int	SM_WEBSTARTUP SM_WEBSTARTUP

Constructor Summary

Constructors

Constructor and Description
MessagePump()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the message pump and releases the message queue.
protected void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
SystemMsg	getMessage() Retrieve a system message.
SystemMsg	getMessage(int type) Retrieves the desired message from the message queue.
SystemMsg	getMessage(int low, int high) Retrieves messages in the specified range from the message queue.
boolean	open() Opens a message pump and creates a message queue.
boolean	postMessage(SystemMsg message) Sends the supplied SystemMsg

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SM_SHUTDOWN

public static final int SM_SHUTDOWN

SM_SHUTDOWN

See Also:

Constant Field Values

SM_PROBE

public static final int SM_PROBE

SM_PROBE

See Also:

Constant Field Values

SM_PWRSUPP

public static final int SM_PWRSUPP

SM_PWRSUPP

See Also:

Constant Field Values

SM_GCRUN

public static final int SM_GCRUN

SM_GCRUN

See Also:

Constant Field Values

SM_WATCHDOG

public static final int SM_WATCHDOG

SM_WATCHDOG

See Also:

Constant Field Values

SM_REGUPDATE

public static final int SM_REGUPDATE

SM_REGUPDATE

See Also:

Constant Field Values

SM_WEBSTARTUP

public static final int SM_WEBSTARTUP

SM_WEBSTARTUP

See Also:

Constant Field Values

SM_WEBSHUTDOWN

public static final int SM_WEBSHUTDOWN

SM_WEBSHUTDOWN

See Also:

Constant Field Values

SM_PROTCMDMSG

public static final int SM_PROTCMDMSG

SM_PROTCMDMSG

See Also:

Constant Field Values

SM_PROTCMDRESP

public static final int SM_PROTCMDRESP

SM_PROTCMDRESP

See Also:

Constant Field Values

SM_PIPEOPEN

public static final int SM_PIPEOPEN

SM_PIPEOPEN

See Also:

Constant Field Values

SM_PIPECLOSE

public static final int SM_PIPECLOSE

SM_PIPECLOSE

See Also:

Constant Field Values

Constructor Detail

MessagePump

public MessagePump()

Method Detail

open

public boolean open()

Opens a message pump and creates a message queue. Once opened the program MUST call a form of getMessage() to process messages in a timely fashion. Any message not to be consumed by the current process MUST be reposted so it can reach the intended recipient. Any process not handling messages in a timely fashion will be considered non-responding by the system and may be terminated.

Returns:

true if successful

close

public void close()

Closes the message pump and releases the message queue. A process MUST insure that close() is called. If the message pump is not closed and the program terminates the system may consider the entire process to be non-responding and terminate.

getMessage

public SystemMsg getMessage(int type)

Retrieves the desired message from the message queue. All other messages are ignored. Note that they are reposted as required for proper operation.

Parameters:

type - - the message type

Returns:

SystemMsg class representing the desired message

getMessage

public SystemMsg getMessage(int low,
                            int high)

Retrieves messages in the specified range from the message queue. All other messages are ignored. Note that they are reposted as required for proper operation.

Parameters:

low - - low end of message range (inclusive)

high - - high end of message range (inclusive)

Returns:

SystemMsg class representing a message passing the filter

getMessage

public SystemMsg getMessage()

Retrieve a system message. This blocks on the message queue and returns the next available message as an instance of SystemMsg. Note that if the caller is not the recipient of the message it MUST be reposted using the postMessage() method for proper operation of the system message pump.

Returns:

SystemMsg class representing the next available message.

postMessage

public boolean postMessage(SystemMsg message)

Sends the supplied SystemMsg

Parameters:

message - SystemMsg calls containing the message to send.

Returns:

true if successful

finalize

protected void finalize()
                 throws Throwable

Description copied from class: Object

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

The finalize method in Object does nothing.

Overrides:

finalize in class Object

Throws:

Throwable - [Need description!]