com.fivecolibs.devices

Interface FCOIPort

All Known Implementing Classes:

FCOCPortSerial, FCOCPortTCP, FCOCPortUDP

public interface FCOIPort

Port standard interface to provide send and receive methods

Version:

1.2

Author:

agardiol

Method Summary

Modifier and Type	Method and Description
int	available() Get number of available bytes in receive buffer
void	close() Ask to close the communication port
void	discardInputBuffer() Discards data from the receive buffer.
int	getData(byte[] acBuffer, int nOffset, int nLength) Get data from the communication port
int	getData(byte[] acBuffer, int nOffset, int nLength, int nTimeout) Get data from the communication port
com.fivecolibs.devices.FCOEPortState	getState()
void	open() Ask to open the communication port
void	putData(byte[] acBuffer, int nOffset, int nLength) Send data through the communication port

Method Detail

getState

com.fivecolibs.devices.FCOEPortState getState()

Returns:

Actual port state

open

void open()
   throws java.io.IOException

Ask to open the communication port

Throws:

java.io.IOException - If open fails

close

void close()

Ask to close the communication port

putData

void putData(byte[] acBuffer,
             int nOffset,
             int nLength)
      throws java.io.IOException

Send data through the communication port

Parameters:

acBuffer - The buffer of data to output

nOffset - The offset in the buffer where data will be sent from

nLength - The length of data that will be sent beginning at the offset

Throws:

java.io.IOException - If an exception occurs in the underlying communication system

getData

int getData(byte[] acBuffer,
            int nOffset,
            int nLength)
     throws java.io.IOException

Get data from the communication port

Parameters:

acBuffer - Buffer where data will be put when read

nOffset - The offset in the buffer where data will be put

nLength - The maximum length of data requested to be put in the buffer

Returns:

The total number of bytes read into the buffer

Throws:

java.io.IOException - If an exception occurs in the underlying communication system

getData

int getData(byte[] acBuffer,
            int nOffset,
            int nLength,
            int nTimeout)
     throws java.io.IOException

Get data from the communication port

Parameters:

acBuffer - Buffer where data will be put when read

nOffset - The offset in the buffer where data will be put

nLength - The maximum length of data requested to be put in the buffer

nTimeout - The time in millisecond to wait if the nLength is not reached.

Returns:

The total number of bytes read into the buffer

Throws:

java.io.IOException - If an exception occurs in the underlying communication system

discardInputBuffer

void discardInputBuffer()

Discards data from the receive buffer.

available

int available()
       throws java.io.IOException

Get number of available bytes in receive buffer

Returns:

Number of bytes available in rx buffer

Throws:

java.io.IOException - Input stream exception