IForteSocket

All Known Implementing Classes:: de.htw.berlin.polysun4diac.forte.comm.AbstractDataBufferLayer, CommFunctionBlockLayer, ForteDataBufferLayer

public interface IForteSocket

Interface for communication between a Java application and IEC 61499 communication service interface function blocks (CSIFBs) running on 4diac-RTE (FORTE).

An IForteSocket can perform the following conversions between JAVA objects and IEC 61499 data types:

JAVA object/primitive	IEC 61499 data type
boolean	BOOL
int	SINT, INT, DINT, USINT, UINT, UDINT
long	LINT, ULINT
float	REAL
double	LREAL
DateAndTime*, LocalDateTime	DATE_AND_TIME
String	STRING**

*DateAndTime is part of this library.

Author:

Marc Jakobi

HTW Berlin

July 2017

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`byte[]`	`array()` This method is intended to allow array-backed buffers to be passed to native code more efficiently.
`int`	`capacity()` Returns the buffer's capacity
`void`	`disconnect()` Closes the connection.
`boolean`	`getBool()` Increments the position by one.
`boolean[]`	`getBoolArray()` Increments the position by one.
`DateAndTime`	`getDateAndTime()` Increments the position by one.
`DateAndTime[]`	`getDateAndTimeArray()` Increments the position by one.
`double`	`getDouble()` Increments the position by one.
`double[]`	`getDoubleArray()` Increments the position by one.
`float`	`getFloat()` Increments the position by one.
`float[]`	`getFloatArray()` Increments the position by one.
`int`	`getInt()` Increments the position by one.
`int[]`	`getIntArray()` Increments the position by one.
`long`	`getLong()` Increments the position by one.
`long[]`	`getLongArray()` Increments the position by one.
`int`	`getNumDataValues()`
`int`	`getPosition()` Returns this data buffer's position.
`java.lang.String`	`getString()` Increments the position by one.
`java.lang.String[]`	`getStringArray()` Increments the position by one.
`ForteDataType`	`getTypeAtNextPosition()` Returns Intended for enabling the dynamic retrieval of data from the buffer.
`ForteDataType`	`getTypeAtPosition(int position)` Intended for enabling the dynamic retrieval of data from the buffer.
`boolean`	`incrementPosition()` Increments this buffer's position by 1.
`boolean`	`isArrayAtPosition(int position)` Intended for enabling the dynamic retrieval of data from the buffer.
`boolean`	`isBool()`
`boolean`	`isBoolArray()`
`boolean`	`isConnected()`
`boolean`	`isDateAndTime()`
`boolean`	`isDateAndTimeArray()`
`boolean`	`isDouble()`
`boolean`	`isDoubleArray()`
`boolean`	`isFloat()`
`boolean`	`isFloatArray()`
`boolean`	`isInt()`
`boolean`	`isIntArray()`
`boolean`	`isLong()`
`boolean`	`isLongArray()`
`boolean`	`isString()`
`boolean`	`isStringArray()`
`java.util.Iterator<java.lang.Object>`	`iterator()` Use this method with caution.
`boolean`	`put(boolean value)` Adds a boolean to be sent to FORTE as an IEC 61499 BOOLEAN to buffer
`boolean`	`put(boolean[] value)` Adds a boolean[] array to be sent to FORTE as an IEC 61499 BOOLEAN array to buffer
`boolean`	`put(DateAndTime value)` Adds a DateAndTime object to be sent to FORTE as IEC 61499 DATE_AND_TIME data to buffer
`boolean`	`put(DateAndTime[] value)` Adds a DateAndTime[] array to be sent to FORTE as an IEC 61499 DATE_AND_TIME array to buffer
`boolean`	`put(double value)` Adds a double to be sent to FORTE as IEC 61499 LREAL to buffer
`boolean`	`put(double[] value)` Adds a double[] array to be sent to FORTE as an IEC 61499 LREAL array to buffer
`boolean`	`put(float value)` Adds a float to be sent to FORTE as IEC 61499 REAL to buffer
`boolean`	`put(float[] value)` Adds a float[] array to be sent to FORTE as an IEC 61499 REAL array to buffer
`boolean`	`put(int value)` Adds a 32 bit int to be sent to FORTE as one of the IEC 61499 32 bit integer types to buffer
`boolean`	`put(int[] value)` Adds a 32 bit int[] array to be sent to FORTE as an IEC 61499 32 bit integer array to buffer
`boolean`	`put(long value)` Adds a 64 bit long integer to be sent to FORTE as an IEC 61499 integer to buffer
`boolean`	`put(long[] value)` Adds a 64 bit long[] integer array to be sent to FORTE as an IEC 61499 integer array to buffer
`boolean`	`put(java.lang.String value)` Adds a String to be sent to FORTE as an IEC 61499 STRING to buffer
`boolean`	`put(java.lang.String[] value)` Adds a String[] array to be sent to FORTE as an IEC 61499 STRING array to buffer
`void`	`recvData()` Translates byte data representing FORTE data types buffered within the internal DataInputStream to Java data types and stores the Java data types in a buffer.
`void`	`reset()` Resets the position to its initialized state and clears the internal byte buffer.
`void`	`rewind()` Resets the position to its initialized state.
`void`	`sendData()` Writes the data stored within this instance's byte buffer to a DataOutputStream.
`void`	`sendRsp()` Sends a response (e.g., a single byte with the value of 5)
`void`	`setDateAndTimeReference(DateAndTime dt)` Sets a DateAndTime object as reference for any new DateAndTime objects received.
`void`	`setPosition(int position)` Sets the position.

- Method Detail
  - array
```
byte[] array()
```
    This method is intended to allow array-backed buffers to be passed to native code more efficiently. Modifications to this buffer's content will cause the returned array's content to be modified, and vice versa.
    
    Returns:
    
    the array that backs this buffer��(optional operation).
  - capacity
```
int capacity()
```
    Returns the buffer's capacity
  - getBool
```
boolean getBool()
```
    Increments the position by one.
    Use isBool() to determine whether the correct data type is at the next position.
    
    Returns:
    
    boolean value at the next position.
    
    Throws:
    
    java.util.NoSuchElementException
  - getBoolArray
```
boolean[] getBoolArray()
```
    Increments the position by one.
    Use isBoolArray() to determine whether the correct data type is at the next position.
    
    Returns:
    
    boolean[] value at the next position.
    
    Throws:
    
    java.util.NoSuchElementException
  - getDateAndTime
```
DateAndTime getDateAndTime()
```
    Increments the position by one.
    Use isDateAndTime() to determine whether the correct data type is at the next position.
    
    Returns:
    
    DateAndTime value at the next position.
    
    Throws:
    
    java.util.NoSuchElementException
  - getDateAndTimeArray
```
DateAndTime[] getDateAndTimeArray()
```
    Increments the position by one.
    Use isDateAndTimeArray() to determine whether the correct data type is at the next position.
    
    Returns:
    
    DateAndTime[] value at the next position.
    
    Throws:
    
    java.util.NoSuchElementException
  - getDouble
```
double getDouble()
```
    Increments the position by one.
    Use isDouble() to determine whether the correct data type is at the next position.
    
    Returns:
    
    double value at the next position.
    
    Throws:
    
    java.util.NoSuchElementException
  - getDoubleArray
```
double[] getDoubleArray()
```
    Increments the position by one.
    Use isDoubleArray() to determine whether the correct data type is at the next position.
    
    Returns:
    
    double[] value at the next position.
    
    Throws:
    
    java.util.NoSuchElementException
  - getFloat
```
float getFloat()
```
    Increments the position by one.
    Use isFloat() to determine whether the correct data type is at the next position.
    
    Returns:
    
    float value at the next position.
    
    Throws:
    
    java.util.NoSuchElementException
  - getFloatArray
```
float[] getFloatArray()
```
    Increments the position by one.
    Use isFloatArray() to determine whether the correct data type is at the next position.
    
    Returns:
    
    float[] value at the next position.
    
    Throws:
    
    java.util.NoSuchElementException
  - getInt
```
int getInt()
```
    Increments the position by one.
    Use isInt() to determine whether the correct data type is at the next position.
    
    Returns:
    
    int value at the next position.
    
    Throws:
    
    java.util.NoSuchElementException
  - getIntArray
```
int[] getIntArray()
```
    Increments the position by one.
    Use isIntArray() to determine whether the correct data type is at the next position.
    
    Returns:
    
    int[] value at the next position.
    
    Throws:
    
    java.util.NoSuchElementException
  - getLong
```
long getLong()
```
    Increments the position by one.
    Use isLong() to determine whether the correct data type is at the next position.
    
    Returns:
    
    long value at the next position.
    
    Throws:
    
    java.util.NoSuchElementException
  - getLongArray
```
long[] getLongArray()
```
    Increments the position by one.
    Use isLongArray() to determine whether the correct data type is at the next position.
    
    Returns:
    
    long[] value at the next position.
    
    Throws:
    
    java.util.NoSuchElementException
  - getNumDataValues
```
int getNumDataValues()
```
    Returns:
    
    The number of data values that can be stored within this buffer.
  - getPosition
```
int getPosition()
```
    Returns this data buffer's position. If this method returns -1, incrementPosition() must be called before extracting data.
  - getString
```
java.lang.String getString()
```
    Increments the position by one.
    Use isString() to determine whether the correct data type is at the next position.
    
    Returns:
    
    String value at the next position.
    
    Throws:
    
    java.util.NoSuchElementException
  - getStringArray
```
java.lang.String[] getStringArray()
```
    Increments the position by one.
    Use isStringArray() to determine whether the correct data type is at the next position.
    
    Returns:
    
    String[] value at the next position.
    
    Throws:
    
    java.util.NoSuchElementException
  - getTypeAtNextPosition
```
ForteDataType getTypeAtNextPosition()
```
    Returns Intended for enabling the dynamic retrieval of data from the buffer. Throws an exception if position is out of bounds.
    
    Returns:
    
    a ForteDataType enumeration representing the FORTE data type at the next position.
  - getTypeAtPosition
```
ForteDataType getTypeAtPosition(int position)
```
    Intended for enabling the dynamic retrieval of data from the buffer. Throws an exception if position is out of bounds.
    
    Parameters:
    
    position -
    
    Returns:
    
    a ForteDataType enumeration representing the FORTE data type at the specified position.
  - incrementPosition
```
boolean incrementPosition()
```
    Increments this buffer's position by 1.
    
    Returns:
    
    true if Position was successfully incremented, false otherwise
  - isArrayAtPosition
```
boolean isArrayAtPosition(int position)
```
    Intended for enabling the dynamic retrieval of data from the buffer. Throws an exception if position is out of bounds.
    
    Parameters:
    
    position -
    
    Returns:
    
    true if the data at the specified position is an array and false otherwise.
  - isBool
```
boolean isBool()
```
    Returns:
    
    true if value at next position is of type boolean. If the position is at the end of the data buffer, the current position is checked.
  - isBoolArray
```
boolean isBoolArray()
```
    Returns:
    
    true if value at next position is of type boolean[]. If the position is at the end of the data buffer, the current position is checked.
  - isDateAndTime
```
boolean isDateAndTime()
```
    Returns:
    
    true if value at next position is of type DateAndTime. If the position is at the end of the data buffer, the current position is checked.
  - isDateAndTimeArray
```
boolean isDateAndTimeArray()
```
    Returns:
    
    true if value at next position is of type DateAndTime[]. If the position is at the end of the data buffer, the current position is checked.
  - isDouble
```
boolean isDouble()
```
    Returns:
    
    true if value at next position is of type double. If the position is at the end of the data buffer, the current position is checked.
  - isDoubleArray
```
boolean isDoubleArray()
```
    Returns:
    
    true if value at next position is of type double[]. If the position is at the end of the data buffer, the current position is checked.
  - isFloat
```
boolean isFloat()
```
    Returns:
    
    true if value at next position is of type float. If the position is at the end of the data buffer, the current position is checked.
  - isFloatArray
```
boolean isFloatArray()
```
    Returns:
    
    true if value at next position is of type float[]. If the position is at the end of the data buffer, the current position is checked.
  - isInt
```
boolean isInt()
```
    Returns:
    
    true if value at next position is of type int. If the position is at the end of the data buffer, the current position is checked.
  - isIntArray
```
boolean isIntArray()
```
    Returns:
    
    true if value at next position is of type int[]. If the position is at the end of the data buffer, the current position is checked.
  - isLong
```
boolean isLong()
```
    Returns:
    
    true if value at next position is of type long. If the position is at the end of the data buffer, the current position is checked.
  - isLongArray
```
boolean isLongArray()
```
    Returns:
    
    true if value at next position is of type long[]. If the position is at the end of the data buffer, the current position is checked.
  - isString
```
boolean isString()
```
    Returns:
    
    true if value at next position is of type String. If the position is at the end of the data buffer, the current position is checked.
  - isStringArray
```
boolean isStringArray()
```
    Returns:
    
    true if value at next position is of type String[]. If the position is at the end of the data buffer, the current position is checked.
  - iterator
```
java.util.Iterator<java.lang.Object> iterator()
```
    Use this method with caution. It is recommended to use the class's type-safe built-in iteration methods instead.
    
    Returns:
    
    Iterator over the elements in this buffer in proper sequence.
    
    See Also:
    
    #isDouble()}, {@link #getDouble()} {@link #isDoubleArray()}, {@link #getDoubleArray()}, {@link #getBool()}, {@link #getInt()} {@link #getLong()}, {@link #getFloat()}, {@link #getString()}, {@link #getDateAndTime()}, {@link #getLocalDateTime()}, {@link #getBoolArray()}, {@link #getIntArray()} {@link #getLongArray()}, {@link #getFloatArray()}, {@link #getStringArray()}, {@link #getDateAndTimeArray()}, {@link #getLocalDateTimeArray()}, etc.
  - put
```
boolean put(boolean value)
```
    Adds a boolean to be sent to FORTE as an IEC 61499 BOOLEAN to buffer
    
    Parameters:
    
    value -
    
    Returns:
    
    true if more data can be added, false if not
  - put
```
boolean put(boolean[] value)
```
    Adds a boolean[] array to be sent to FORTE as an IEC 61499 BOOLEAN array to buffer
    
    Parameters:
    
    value -
    
    Returns:
    
    true if more data can be added, false if not
  - put
```
boolean put(DateAndTime value)
```
    Adds a DateAndTime object to be sent to FORTE as IEC 61499 DATE_AND_TIME data to buffer
    
    Parameters:
    
    value -
    
    Returns:
    
    true if more data can be added, false if not
  - put
```
boolean put(DateAndTime[] value)
```
    Adds a DateAndTime[] array to be sent to FORTE as an IEC 61499 DATE_AND_TIME array to buffer
    
    Parameters:
    
    value -
    
    Returns:
    
    true if more data can be added, false if not
  - put
```
boolean put(double value)
```
    Adds a double to be sent to FORTE as IEC 61499 LREAL to buffer
    
    Parameters:
    
    value -
    
    Returns:
    
    true if more data can be added, false if not
  - put
```
boolean put(double[] value)
```
    Adds a double[] array to be sent to FORTE as an IEC 61499 LREAL array to buffer
    
    Parameters:
    
    value -
    
    Returns:
    
    true if more data can be added, false if not
  - put
```
boolean put(float value)
```
    Adds a float to be sent to FORTE as IEC 61499 REAL to buffer
    
    Parameters:
    
    value -
    
    Returns:
    
    true if more data can be added, false if not
  - put
```
boolean put(float[] value)
```
    Adds a float[] array to be sent to FORTE as an IEC 61499 REAL array to buffer
    
    Parameters:
    
    value -
    
    Returns:
    
    true if more data can be added, false if not
  - put
```
boolean put(int value)
```
    Adds a 32 bit int to be sent to FORTE as one of the IEC 61499 32 bit integer types to buffer
    
    Parameters:
    
    value - Value to be converted to byte data
    
    Returns:
    
    true if more data can be added, false if not
  - put
```
boolean put(int[] value)
```
    Adds a 32 bit int[] array to be sent to FORTE as an IEC 61499 32 bit integer array to buffer
    
    Parameters:
    
    value -
    
    Returns:
    
    true if more data can be added, false if not
  - put
```
boolean put(long value)
```
    Adds a 64 bit long integer to be sent to FORTE as an IEC 61499 integer to buffer
    
    Parameters:
    
    value -
    
    Returns:
    
    true if more data can be added, false if not
  - put
```
boolean put(long[] value)
```
    Adds a 64 bit long[] integer array to be sent to FORTE as an IEC 61499 integer array to buffer
    
    Parameters:
    
    value -
    
    Returns:
    
    true if more data can be added, false if not
  - put
```
boolean put(java.lang.String value)
```
    Adds a String to be sent to FORTE as an IEC 61499 STRING to buffer
    
    Parameters:
    
    value -
    
    Returns:
    
    true if more data can be added, false if not
  - put
```
boolean put(java.lang.String[] value)
```
    Adds a String[] array to be sent to FORTE as an IEC 61499 STRING array to buffer
    
    Parameters:
    
    value -
    
    Returns:
    
    true if more data can be added, false if not
  - recvData
```
void recvData()
       throws java.io.IOException,
              UnsupportedForteDataTypeException
```
    Translates byte data representing FORTE data types buffered within the internal DataInputStream to Java data types and stores the Java data types in a buffer. reset() is called after completing the write operation. Before calling this method, a data input layer must be set using #setInputLayer(AbstractCommunicationLayer).
    
    Parameters:
    
    iStream - DataInputStrem connected to a FORTE CLIENT or SERVER function block
    
    Throws:
    
    java.io.IOException
    
    UnsupportedForteDataTypeException
  - reset
```
void reset()
```
    Resets the position to its initialized state and clears the internal byte buffer.
  - rewind
```
void rewind()
```
    Resets the position to its initialized state.
  - setDateAndTimeReference
```
void setDateAndTimeReference(DateAndTime dt)
```
    Sets a DateAndTime object as reference for any new DateAndTime objects received.
  - setPosition
```
void setPosition(int position)
```
    Sets the position. The position is limited to [-1, getNumDataValues()]. -1 is the initialized state.
    
    Parameters:
    
    position -
  - sendData
```
void sendData()
       throws java.io.IOException
```
    Writes the data stored within this instance's byte buffer to a DataOutputStream. reset() is called after completing the write operation. Before calling this method, the data output layer must be set using #setOutputLayer(AbstractCommunicationLayer).
    
    Throws:
    
    java.io.IOException
  - sendRsp
```
void sendRsp()
      throws java.io.IOException
```
    Sends a response (e.g., a single byte with the value of 5)
    
    Throws:
    
    java.io.IOException
  - disconnect
```
void disconnect()
         throws java.io.IOException
```
    Closes the connection.
    
    Throws:
    
    java.io.IOException
  - isConnected
```
boolean isConnected()
```
    Returns:
    
    true if the socket is connected, false otherwise.

Interface IForteSocket

Method Summary

Method Detail

array

capacity

getBool

getBoolArray

getDateAndTime

getDateAndTimeArray

getDouble

getDoubleArray

getFloat

getFloatArray

getInt

getIntArray

getLong

getLongArray

getNumDataValues

getPosition

getString

getStringArray

getTypeAtNextPosition

getTypeAtPosition

incrementPosition

isArrayAtPosition

isBool

isBoolArray

isDateAndTime

isDateAndTimeArray

isDouble

isDoubleArray

isFloat

isFloatArray

isInt

isIntArray

isLong

isLongArray

isString

isStringArray

iterator

put

put

put

put

put

put

put

put

put

put

put

put

put

put

recvData

reset

rewind

setDateAndTimeReference

setPosition

sendData

sendRsp

disconnect

isConnected