AdsSocketChannel

java.lang.Object
- util.PropertyContainer
- - io.AbstractDriver
  - - stella.net.ads.AdsSocketChannel

All Implemented Interfaces:

Driver, Cloneable, Initializable, PropertySupplying

Direct Known Subclasses:

PollingBeckhoffServer
```
public class AdsSocketChannel
extends AbstractDriver
implements Initializable
```
We communicate with an AMS PLC using a TCP/IP socket connection. The AMS source and target ID are to be provided in the properties and must match the configuration. The communication is done through a socket connection at KEY_SOCKETSERVER listening on port KEY_SOCKETPORT.

Author:

wooz

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AdsSocketChannel.Close`
`(package private) static class`	`AdsSocketChannel.Group`
`static class`	`AdsSocketChannel.Info` Constructs an ADS driver from a properties file, read in the device info and print out the result.
`static class`	`AdsSocketChannel.Open`

Field Summary

Fields
Modifier and Type	Field and Description
`static Byte`	`BFALSE` The byte version for false.
`static Byte`	`BTRUE` The byte version for true.
`private static boolean`	`DEFBLOCKING`
`private int`	`ID` A session ID.
`private SocketChannel`	`io`
`static String`	`KEY_BLOCKING`
`static String`	`KEY_KEEPALIVE`
`static String`	`KEY_SOCKETPORT`
`static String`	`KEY_SOCKETSERVER`
`static String`	`KEY_SOCKETTIMEOUT`
`static String`	`KEY_SOURCEAMSID`
`static String`	`KEY_SOURCEPORT`
`static String`	`KEY_TARGETAMSID`
`static String`	`KEY_TARGETPORT`
`private byte[]`	`sourceid`
`private byte[]`	`targetid`

Fields inherited from class io.AbstractDriver
KEY_DRIVERNAME

Fields inherited from class util.PropertyContainer
KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying
CONFIG, KEY_CLASS

Constructor Summary

Constructors
Constructor and Description

AdsSocketChannel(Map<String,String> props)

Constructors
Constructor and Description
`AdsSocketChannel(Map<String,String> props)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`close()` Performs clean-up step when the driver is unloaded.
`boolean`	`deleteHandleForVariable(long handle)` Releases a handle to a variable.
`boolean`	`deleteHandlesForBlock(Collection<Long> handles)` Requests multiple variable handles by using an ADS sum command.
`boolean`	`deleteHandlesForBlock(Map<String,Long> handles)` Requests multiple variable handles by using an ADS sum command.
`boolean`	`ensureConnect()` Establish either a new connection or return immediately if already connected.
`private AdsPacket`	`execute(AdsCommand cmd)`
`Map<String,AdsValue>`	`getAllVariables()` Following the sparse documentation, we are able to get a variable name plus its value skeleton out of the device info of the beckhoff system.
`DeviceInfoReply`	`getDeviceInfo()`
`long`	`getHandleForVariable(String name)` Returns a handle to a variable name.
`Map<String,Long>`	`getHandlesForBlock(Collection<String> vnames)` Requests multiple variable handles by using an ADS sum command.
`Number`	`getNumericByHandle(long handle, AdsValue skeleton)` Reads a number from a re-usable handle.
`Number`	`getNumericByName(String name, AdsValue skeleton)` Queries a variable by name, returning the result as a number.
`byte[]`	`getSourceId()` Returns six bytes parsed out of the `KEY_SOURCEAMSID` property.
`int`	`getSourcePort()` Only for assemblage of correct header.
`String`	`getStringByHandle(long handle)` Queries a variable by its handle, returning the result as a string.
`String`	`getStringByName(String name)` Queries a variable by name, returning the result as a string.
`private int`	`getSumBytes(Collection<AdsValue> vars)`
`byte[]`	`getTargetId()` Returns six bytes parsed out of the `KEY_TARGETAMSID` property.
`int`	`getTargetPort()` Only for assemblage of correct header.
`Map<String,Number>`	`getValuesByHandleBlock(Map<String,Long> handle, Map<String,AdsValue> type)` We read in numerical values for all handles.
`Map<String,Number>`	`getValuesByNameBlock(Map<String,AdsValue> skel)` Queries a variable by name, returning the result as a number.
`void`	`init()`
`boolean`	`isOpen()` Queries the initalization status of the driver.
`private int`	`nextID()` Returns the next session ID.
`boolean`	`open()` We open a socket channel to the socket address specified in `KEY_SOCKETSERVER` and `KEY_SOCKETPORT`.
`private static byte[]`	`parseAmsId(String ip)`
`private List<String>`	`prepareSumBuffer(Map<String,Long> handle, Map<String,AdsValue> type, ByteBuffer into)`
`private void`	`printVariableInfo()` Mainly for test purposes.
`private ReadReply`	`readFromHandle(long handle)` Communication cycle to read from a handle.
`private static String`	`readZeroTerminated(ByteBuffer info, int namelen)`
`boolean`	`writeNumericToHandle(long handle, AdsValue skeleton, Number push)`
`boolean`	`writeNumericToName(String name, AdsValue skeleton, Number push)`
`boolean`	`writeStringToHandle(long handle, String push)`
`boolean`	`writeStringToName(String name, String push)`
`private boolean`	`writeToHandle(long handle, ByteBuffer io)`
`boolean`	`writeValuesByHandleBlock(Map<String,Long> handle, Map<String,AdsValue> type, Map<String,Number> value)` We write numerical values for all handles.

Methods inherited from class io.AbstractDriver
createDriver, equals, getDriverName, hashCode

Methods inherited from class util.PropertyContainer
augment, augment, augment, augment, augment, clone, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - KEY_TARGETAMSID
```
public static final String KEY_TARGETAMSID
```
    See Also:
    
    Constant Field Values
  - KEY_TARGETPORT
```
public static final String KEY_TARGETPORT
```
    See Also:
    
    Constant Field Values
  - KEY_SOURCEAMSID
```
public static final String KEY_SOURCEAMSID
```
    See Also:
    
    Constant Field Values
  - KEY_SOURCEPORT
```
public static final String KEY_SOURCEPORT
```
    See Also:
    
    Constant Field Values
  - KEY_SOCKETSERVER
```
public static final String KEY_SOCKETSERVER
```
    See Also:
    
    Constant Field Values
  - KEY_SOCKETPORT
```
public static final String KEY_SOCKETPORT
```
    See Also:
    
    Constant Field Values
  - KEY_SOCKETTIMEOUT
```
public static final String KEY_SOCKETTIMEOUT
```
    See Also:
    
    Constant Field Values
  - KEY_BLOCKING
```
public static final String KEY_BLOCKING
```
    See Also:
    
    Constant Field Values
  - KEY_KEEPALIVE
```
public static final String KEY_KEEPALIVE
```
    See Also:
    
    Constant Field Values
  - DEFBLOCKING
```
private static final boolean DEFBLOCKING
```
    See Also:
    
    Constant Field Values
  - targetid
```
private byte[] targetid
```
  - sourceid
```
private byte[] sourceid
```
  - io
```
private SocketChannel io
```
  - ID
```
private int ID
```
    A session ID.
  - BFALSE
```
public static final Byte BFALSE
```
    The byte version for false.
  - BTRUE
```
public static final Byte BTRUE
```
    The byte version for true.
- Constructor Detail
  - AdsSocketChannel
```
public AdsSocketChannel(Map<String,String> props)
```
    Parameters:
    
    props -
- Method Detail
  - nextID
```
private int nextID()
```
    Returns the next session ID.
  - init
```
public void init()
```
    Specified by:
    
    init in interface Initializable
  - getTargetId
```
public byte[] getTargetId()
```
    Returns six bytes parsed out of the KEY_TARGETAMSID property.
    
    Returns:
    
    the target ID, six bytes network order
  - getTargetPort
```
public int getTargetPort()
```
    Only for assemblage of correct header.
    
    Returns:
    
    the target port
  - getSourceId
```
public byte[] getSourceId()
```
    Returns six bytes parsed out of the KEY_SOURCEAMSID property.
    
    Returns:
    
    the source ID, six bytes network order.
  - getSourcePort
```
public int getSourcePort()
```
    Only for assemblage of correct header.
    
    Returns:
    
    the source port
  - parseAmsId
```
private static byte[] parseAmsId(String ip)
```
  - open
```
public boolean open()
             throws IOException
```
    We open a socket channel to the socket address specified in KEY_SOCKETSERVER and KEY_SOCKETPORT. It is not advised to state a socket timeout, but if so, the underlying socket to the channel is manipulated in it SO timeout.
    
    Specified by:
    
    open in interface Driver
    
    Returns:
    
    True if initialization was successful.
    
    Throws:
    
    IOException
  - ensureConnect
```
public boolean ensureConnect()
                      throws IOException
```
    Establish either a new connection or return immediately if already connected. If the ads is not connected, a connection is established either by finishing a connection with SocketChannel.finishConnect() if a connection is pending or by invoking SocketChannel.connect(SocketAddress) with a socket address derived from KEY_SOCKETSERVER and KEY_SOCKETPORT.
    This behavior differs from the SocketChannel.connect(SocketAddress) as it does not throw an exception, if already connected, but rather returns true. This method is intended to be called repeatedly without having to worry if a connection is already established.
    
    Returns:
    
    The is-connected state from the channel
    
    Throws:
    
    IOException
    
    See Also:
    
    SocketChannel
  - isOpen
```
public boolean isOpen()
```
    Description copied from interface: Driver
    
    Queries the initalization status of the driver. If the driver has been successfully initalized this method should return true.
    
    Specified by:
    
    isOpen in interface Driver
    
    Returns:
    
    True, if a previous initialization was successful
  - close
```
public boolean close()
              throws IOException
```
    Description copied from interface: Driver
    
    Performs clean-up step when the driver is unloaded. A serial-port driver will probably close the serial port in this method.
    
    Specified by:
    
    close in interface Driver
    
    Returns:
    
    True if clean-up was successful.
    
    Throws:
    
    IOException
  - getAllVariables
```
public Map<String,AdsValue> getAllVariables()
                                     throws IOException
```
    Following the sparse documentation, we are able to get a variable name plus its value skeleton out of the device info of the beckhoff system. There is also a group index and offset assigned to each variable, which, in turn, could be used to read the value of the variable, but there is no easy way to translate this into a variable handle, thus block command cannot be used with the information retrieved here. The only possibility is to use the mapping returned here, query in block for the handles of the variable names and then proceed further from there.
    Types that cannot be used as AdsValue skeletons are ignored.
    
    Returns:
    
    All usable variables
    
    Throws:
    
    IOException
  - printVariableInfo
```
private void printVariableInfo()
                        throws IOException
```
    Mainly for test purposes.
    
    Throws:
    
    IOException
  - readZeroTerminated
```
private static String readZeroTerminated(ByteBuffer info,
                                         int namelen)
```
  - getDeviceInfo
```
public DeviceInfoReply getDeviceInfo()
                              throws IOException
```
    Throws:
    
    IOException
  - getStringByName
```
public String getStringByName(String name)
                       throws IOException
```
    Queries a variable by name, returning the result as a string.
    
    Parameters:
    
    name -
    
    Returns:
    
    Throws:
    
    IOException
  - getStringByHandle
```
public String getStringByHandle(long handle)
                         throws IOException
```
    Queries a variable by its handle, returning the result as a string. The handle can be reused until it is released with a call to delete handle.
    
    Parameters:
    
    name -
    
    Returns:
    
    Throws:
    
    IOException
  - getNumericByName
```
public Number getNumericByName(String name,
                               AdsValue skeleton)
                        throws IOException
```
    Queries a variable by name, returning the result as a number. The type of the value, i.e., how its byte representation is interpreted as a numerical value, is provided as a skeleton number.
    
    Parameters:
    
    name -
    
    skeleton -
    
    Returns:
    
    Throws:
    
    IOException
  - getNumericByHandle
```
public Number getNumericByHandle(long handle,
                                 AdsValue skeleton)
                          throws IOException
```
    Reads a number from a re-usable handle.
    
    Parameters:
    
    handle -
    
    skeleton -
    
    Returns:
    
    Throws:
    
    IOException
  - getValuesByNameBlock
```
public Map<String,Number> getValuesByNameBlock(Map<String,AdsValue> skel)
                                        throws IOException
```
    Queries a variable by name, returning the result as a number. The type of the value, i.e., how its byte representation is interpreted as a numerical value, is provided as a skeleton number.
    
    Parameters:
    
    name -
    
    skeleton -
    
    Returns:
    
    Throws:
    
    IOException
  - readFromHandle
```
private ReadReply readFromHandle(long handle)
                          throws IOException
```
    Communication cycle to read from a handle.
    
    Parameters:
    
    handle -
    
    Returns:
    
    Throws:
    
    IOException
  - writeNumericToName
```
public boolean writeNumericToName(String name,
                                  AdsValue skeleton,
                                  Number push)
                           throws IOException
```
    Throws:
    
    IOException
  - writeNumericToHandle
```
public boolean writeNumericToHandle(long handle,
                                    AdsValue skeleton,
                                    Number push)
                             throws IOException
```
    Parameters:
    
    handle -
    
    skeleton -
    
    push -
    
    Returns:
    
    Throws:
    
    IOException
  - writeStringToName
```
public boolean writeStringToName(String name,
                                 String push)
                          throws IOException
```
    Throws:
    
    IOException
  - writeStringToHandle
```
public boolean writeStringToHandle(long handle,
                                   String push)
                            throws IOException
```
    Parameters:
    
    handle -
    
    push -
    
    Returns:
    
    Throws:
    
    IOException
  - writeToHandle
```
private boolean writeToHandle(long handle,
                              ByteBuffer io)
                       throws IOException
```
    Parameters:
    
    handle -
    
    io -
    
    Throws:
    
    IOException
  - getHandleForVariable
```
public long getHandleForVariable(String name)
                          throws IOException
```
    Returns a handle to a variable name. It is assumed that the handle stays valid as long as it is not deleted again, thus multiple reading and writing of a variable should be possible using the same handle.
    
    Parameters:
    
    name -
    
    Returns:
    
    Throws:
    
    IOException
  - getHandlesForBlock
```
public Map<String,Long> getHandlesForBlock(Collection<String> vnames)
                                    throws IOException
```
    Requests multiple variable handles by using an ADS sum command.
    
    Throws:
    
    IOException
  - deleteHandleForVariable
```
public boolean deleteHandleForVariable(long handle)
                                throws IOException
```
    Releases a handle to a variable. It is assumed that the variable is still present in the PLC after releasing a handle, but if it is to be queried again, a new handle has to be allocated.
    
    Parameters:
    
    handle -
    
    Returns:
    
    Throws:
    
    IOException
  - deleteHandlesForBlock
```
public boolean deleteHandlesForBlock(Collection<Long> handles)
                              throws IOException
```
    Requests multiple variable handles by using an ADS sum command.
    
    Throws:
    
    IOException
  - getValuesByHandleBlock
```
public Map<String,Number> getValuesByHandleBlock(Map<String,Long> handle,
                                                 Map<String,AdsValue> type)
                                          throws IOException
```
    We read in numerical values for all handles. Have to provide the data types, too
    
    Throws:
    
    IOException
  - writeValuesByHandleBlock
```
public boolean writeValuesByHandleBlock(Map<String,Long> handle,
                                        Map<String,AdsValue> type,
                                        Map<String,Number> value)
                                 throws IOException
```
    We write numerical values for all handles. Have to provide the data types, too.
    
    Throws:
    
    IOException
  - prepareSumBuffer
```
private List<String> prepareSumBuffer(Map<String,Long> handle,
                                      Map<String,AdsValue> type,
                                      ByteBuffer into)
```
  - getSumBytes
```
private int getSumBytes(Collection<AdsValue> vars)
```
  - deleteHandlesForBlock
```
public boolean deleteHandlesForBlock(Map<String,Long> handles)
                              throws IOException
```
    Requests multiple variable handles by using an ADS sum command.
    
    Throws:
    
    IOException
  - execute
```
private AdsPacket execute(AdsCommand cmd)
                   throws IOException
```
    Throws:
    
    IOException

Class AdsSocketChannel

Nested Class Summary

Field Summary

Fields inherited from class io.AbstractDriver

Fields inherited from class util.PropertyContainer

Fields inherited from interface util.PropertySupplying

Constructor Summary

Method Summary

Methods inherited from class io.AbstractDriver

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Field Detail

KEY_TARGETAMSID

KEY_TARGETPORT

KEY_SOURCEAMSID

KEY_SOURCEPORT

KEY_SOCKETSERVER

KEY_SOCKETPORT

KEY_SOCKETTIMEOUT

KEY_BLOCKING

KEY_KEEPALIVE

DEFBLOCKING

targetid

sourceid

io

ID

BFALSE

BTRUE

Constructor Detail

AdsSocketChannel

Method Detail

nextID

init

getTargetId

getTargetPort

getSourceId

getSourcePort

parseAmsId

open

ensureConnect

isOpen

close

getAllVariables

printVariableInfo

readZeroTerminated

getDeviceInfo

getStringByName

getStringByHandle

getNumericByName

getNumericByHandle

getValuesByNameBlock

readFromHandle

writeNumericToName

writeNumericToHandle

writeStringToName

writeStringToHandle

writeToHandle

getHandleForVariable

getHandlesForBlock

deleteHandleForVariable

deleteHandlesForBlock

getValuesByHandleBlock

writeValuesByHandleBlock

prepareSumBuffer

getSumBytes

deleteHandlesForBlock

execute