de.htw.berlin.polysun4diac.forte.comm

Class CommLayerParams

java.lang.Object

java.net.SocketAddress

java.net.InetSocketAddress

de.htw.berlin.polysun4diac.forte.comm.CommLayerParams

All Implemented Interfaces:

java.io.Serializable

public class CommLayerParams
extends java.net.InetSocketAddress

Class for setting up a connection between a Polysun PluginController and a 4diac application running on 4diac-RTE (FORTE). An instance of this class is initialized with the parameters (IP socket address, port number) used for building the OSI communication layers. This class implements an IP Socket Address (IP address + port number) It can also be a pair (hostname + port number), in which case an attempt will be made to resolve the hostname. If resolution fails then the address is said to be unresolved but can still be used on some circumstances like connecting through a proxy. It provides an immutable object used by sockets for binding, connecting, or as returned values. The wildcard is a special local IP address. It usually means "any" and can only be used for bind operations.

This class can be used to generate an IForteSocket object, which can be used to communicate with a communication service interface function block (CSIFB) on FORTE. Before creating the IForteSocket object, the ForteServiceType should be set (if none is set, the default is ForteServiceType.CLIENT) using the setServiceType(ForteServiceType) method.

Additionally, the inputs and outputs must be set by calling addInput(ForteDataType) and addOutput(ForteDataType) (if the numbers of inputs/outputs differ from each other) or by calling addInputOutput(ForteDataType) if the numbers of inputs/outputs are the same. To add arrays as inputs or outputs, the following methods can be called: addInput(ForteDataType, int), addOutput(ForteDataType, int) and addInputOutput(ForteDataType, int). If no output is added, calling recvData() on the generated IForteSocket will await a response from the connected FORTE CSIFB. Likewise, if no input is added, calling sendData() on the generated IForteSocket will send a response to the connected FORTE CSIFB.

Once all the parameters are set, an IForteSocket can be initialized by calling this class's makeIPSocket() method.

Author:

Marc Jakobi

HTW Berlin

July 2017

See Also:

IForteSocket, ForteServiceType, AbstractCommunicationLayer, ForteDataType, IPluginController, FORTE communication architecture, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommLayerParams(java.net.InetAddress addr, int port) Creates a set of communication layer parameters.
CommLayerParams(int port) Creates a set of communication layer parameters with the default address and a specified port.
CommLayerParams(java.lang.String hostname, int port) Creates a set of communication layer parameters.

Method Summary

Modifier and Type	Method and Description
void	addInput(ForteDataType dataType) Adds a data input to the set-up parameters.
void	addInput(ForteDataType dataType, int arrayLength) Adds a data input with a specified array length to the set-up parameters.
void	addInputOutput(ForteDataType dataType) Adds a data type as an input and as an output at the same time.
void	addInputOutput(ForteDataType dataType, int arrayLength) Adds a data type with a specified array length as an input and as an output at the same time.
void	addOutput(ForteDataType dataType) Adds a data output to the set-up parameters.
void	addOutput(ForteDataType dataType, int arrayLength) Adds a data output with a specified array length to the set-up parameters.
java.net.InetSocketAddress	getInetSocketAddress()
java.util.List<java.lang.Integer>	getInputArrayLengths()
java.util.List<java.lang.Enum<?>>	getInputs()
java.util.List<java.lang.Integer>	getOutputArrayLengths()
java.util.List<java.lang.Enum<?>>	getOutputs()
ForteServiceType	getServiceType()
IForteSocket	makeIPSocket()
void	setServiceType(ForteServiceType type) Sets the ForteServiceType enum used by the IPCommunicationLayer to determine which layer to set up below.

Methods inherited from class java.net.InetSocketAddress

createUnresolved, equals, getAddress, getHostName, getHostString, getPort, hashCode, isUnresolved, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CommLayerParams

public CommLayerParams(int port)

Creates a set of communication layer parameters with the default address and a specified port.

Parameters:

port - the port number. A valid port value is between 0 and 65535. A port number of zero will let the system pick up an ephemeral port in a bind operation.

CommLayerParams

public CommLayerParams(java.net.InetAddress addr,
                       int port)

Creates a set of communication layer parameters.

Parameters:

addr - the IP address

port - the port number. A valid port value is between 0 and 65535. A port number of zero will let the system pick up an ephemeral port in a bind operation.

serviceType - one of the 4 IEC 61499 communication service interface function block (CSIFB) types.

CommLayerParams

public CommLayerParams(java.lang.String hostname,
                       int port)

Creates a set of communication layer parameters.

Parameters:

hostname - the Host name. An attempt will be made to resolve the hostname into an InetAddress. If that attempt fails, the address will be flagged as unresolved. If there is a security manager, its checkConnect method is called with the host name as its argument to check the permissiom to resolve it. This could result in a SecurityException.

port - the port number. A valid port value is between 0 and 65535. A port number of zero will let the system pick up an ephemeral port in a bind operation.

serviceType - one of the 4 IEC 61499 communication service interface function block (CSIFB) types.

Method Detail

getServiceType

public ForteServiceType getServiceType()

Returns:

A ForteServiceType enum used by the IPCommunicationLayer to determine which layer to set up below

setServiceType

public void setServiceType(ForteServiceType type)

Sets the ForteServiceType enum used by the IPCommunicationLayer to determine which layer to set up below.

getInetSocketAddress

public java.net.InetSocketAddress getInetSocketAddress()

Returns:

an InetSocketAddress object with this object's IP and port settings.

addInput

public void addInput(ForteDataType dataType)

Adds a data input to the set-up parameters. The inputs are sent to FORTE and their types should correspond with those of the function block on the receiving end. Inputs are initialized in the order at which they were added to this object.

Parameters:

dataType - the FORTE data type of the input.

addInput

public void addInput(ForteDataType dataType,
                     int arrayLength)

Adds a data input with a specified array length to the set-up parameters. The inputs are sent to FORTE and their types should correspond with those of the function block on the receiving end. Inputs are initialized in the order at which they were added to this object.

Parameters:

dataType - the FORTE data type of the input.

arrayLength - length of the array.

addOutput

public void addOutput(ForteDataType dataType)

Adds a data output to the set-up parameters. The outputs are received from FORTE and their types should correspond with those of the function block on the sending end. Outputs are initialized in the order at which they were added to this object.

Parameters:

dataType - the FORTE data type of the output.

addOutput

public void addOutput(ForteDataType dataType,
                      int arrayLength)

Adds a data output with a specified array length to the set-up parameters. The outputs are received from FORTE and their types should correspond with those of the function block on the sending end. Outputs are initialized in the order at which they were added to this object.

Parameters:

dataType - the FORTE data type of the output

arrayLength - length of the array

addInputOutput

public void addInputOutput(ForteDataType dataType)

Adds a data type as an input and as an output at the same time.

Parameters:

dataType - the FORTE input/output

addInputOutput

public void addInputOutput(ForteDataType dataType,
                           int arrayLength)

Adds a data type with a specified array length as an input and as an output at the same time.

Parameters:

dataType - the FORTE input/output

arrayLength - length of the array

getInputs

public java.util.List<java.lang.Enum<?>> getInputs()

Returns:

data types to be sent.

getOutputs

public java.util.List<java.lang.Enum<?>> getOutputs()

Returns:

data types to be received.

getInputArrayLengths

public java.util.List<java.lang.Integer> getInputArrayLengths()

Returns:

array lengths of the data inputs to be sent to FORTE

getOutputArrayLengths

public java.util.List<java.lang.Integer> getOutputArrayLengths()

Returns:

array lengths of the data outputs to be received from FORTE

makeIPSocket

public IForteSocket makeIPSocket()
                          throws java.io.IOException

Returns:

an IP server socket that can be used to communicate with an IEC 61499 CLIENT, SERVER, SUBSCRIBE or PUBLISH function block, depending on the parameters set for this object. The connection is opened by passing this object to the socket's openConnection() method.

Throws:

java.io.IOException