com.lts.ipc.fifo
Class FIFOResult

java.lang.Object
  com.lts.ipc.fifo.FIFOResult

public class FIFOResult
extends java.lang.Object

An internal class to hold the results of a call to a JNI method.

NOTE

This is an internal class and not intended for general use.

Description

This class is used to pass multiple results between the JNI layer and the Java layer of named pipes. JNI calls can only return a single result, so to overcome that limitation, an instance of this class is passed back instead.

Properties

• handle - an integer value the operating system uses to identify the named pipe
• errorCode - a value the native method uses to communicate a problem with the operation. The codes are defined by the ERROR_ constants that this class defines.
• resultCode - The Java level result code. Generally a value of 0 means that the call succeeded whereas a non-zero code means that there was a problem.
• byteCount - For operations like read and write, this property specifies the number of bytes actually read or written by the underlying operation.

Author:

cnh

Field Summary

int	byteCount
static int	ERROR_ACCESS_DENIED
static int	ERROR_CONNECT An attempt to connect to a FIFO failed.
static int	ERROR_INVALID_HANDLE An attempt was made to perform some operation such as listening or writing to a named pipe when the client did not have a valid pipe handle.
static int	ERROR_NOT_FOUND An attempt was made to open a file, but either a component of the path to the file or the file itself does not exist.
static int	ERROR_PIPE_BUSY An attempt was made to connect to a named pipe, but failed because all the instances were already connected to other clients.
static int	ERROR_PIPE_CLOSED
static int	ERROR_READ A generic problem occurred while trying to read from the FIFO.
static int	ERROR_SELECT An error was encountered while making a call to wait for an IPC mechanism to become ready (e.g., select or WaitForSingleObject).
static int	ERROR_UNKNOWN
int	errorCode
long	handle
int	resultCode
boolean	server Is the FIFO a server?
static int	SUCCESS
long	syncObject A windows-specific object required when using non-blocking FIFOs.
static int	TIMEOUT Timeout while waiting for something.

Constructor Summary

FIFOResult()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_UNKNOWN

public static final int ERROR_UNKNOWN

See Also:

Constant Field Values

SUCCESS

public static final int SUCCESS

See Also:

Constant Field Values

ERROR_ACCESS_DENIED

public static final int ERROR_ACCESS_DENIED

See Also:

Constant Field Values

ERROR_INVALID_HANDLE

public static final int ERROR_INVALID_HANDLE

An attempt was made to perform some operation such as listening or writing to a named pipe when the client did not have a valid pipe handle.

See Also:

Constant Field Values

ERROR_PIPE_BUSY

public static final int ERROR_PIPE_BUSY

An attempt was made to connect to a named pipe, but failed because all the instances were already connected to other clients.

See Also:

Constant Field Values

ERROR_NOT_FOUND

public static final int ERROR_NOT_FOUND

An attempt was made to open a file, but either a component of the path to the file or the file itself does not exist.

See Also:

Constant Field Values

ERROR_PIPE_CLOSED

public static final int ERROR_PIPE_CLOSED

See Also:

Constant Field Values

ERROR_CONNECT

public static final int ERROR_CONNECT

An attempt to connect to a FIFO failed.

See Also:

Constant Field Values

ERROR_READ

public static final int ERROR_READ

A generic problem occurred while trying to read from the FIFO.

See Also:

Constant Field Values

TIMEOUT

public static final int TIMEOUT

Timeout while waiting for something.

See Also:

Constant Field Values

ERROR_SELECT

public static final int ERROR_SELECT

An error was encountered while making a call to wait for an IPC mechanism to become ready (e.g., select or WaitForSingleObject).

See Also:

Constant Field Values

resultCode

public int resultCode

handle

public long handle

errorCode

public int errorCode

byteCount

public int byteCount

server

public boolean server

Is the FIFO a server?

A value of true indicates that whoever is using the FIFO is the server. A value of false means that the user is not the server.

This is only relevant for the Windows platform, where a different system call must be used depending on whether this is the client or the server.

syncObject

public long syncObject

A windows-specific object required when using non-blocking FIFOs.

Constructor Detail

FIFOResult

public FIFOResult()