.

Average: 0
Rating Count: 0

Development status: Released, Release: release_2_1_1
Information status: Updated
Repository: http://svn.code.sf.net/p/tango-ds/code/DeviceClasses/Communication/Socket
Contact:



Class Description


This class implements basic socket IPC.

Families: Communication

Key words:

Platform: Unix Like

Language: Cpp

License:

Contact:

Hardware


Manufacturer: none

Bus: Socket

Class interface


Attributes:

Name Description
portScalar: DevULong Used port
hostnameScalar: DevString Gives the name of the host were the socket is connected to

Commands:

Name Description
WriteReadCharArrayInput: DevVarLongStringArray
str[0] = String to send lg[0] = Number of bytes to be read
Output: DevVarCharArray
Read bytes
Send a given string to the socket and waits for a given number of binary bytes. Those received bytes are returned to the caller.
ReadCharArrayInput: DevLong
number of char to read
Output: DevVarCharArray
char read on socket
read on socket and return output Argument.
ReadUntilInput: DevString
This is the terminator
Output: DevString
This is the read string.
This command read data from the socket until the terminator has been reached.
ReadlnInput: DevVoid
Output: DevString
argout
Reads from a socket until a "\n" has been received.
ReadInput: DevVoid
Output: DevString
Command used to read a string from the socket.
WriteCharArrayInput: DevVarCharArray
array to write
Output: DevVoid
write on socket input Argument.
WriteReadUntilInput: DevVarStringArray
[0] = Command string to be send, [1] = end of message character
Output: DevString
Answer string.
Write to the socket and waits for the answer. The answer is triggered by select() which indicates that the the anser has arrived.
WriteAndReadInput: DevString
Command string.
Output: DevString
Answer string.
Write to the socket and waits for the answer. The end of the answer is triggered by the new line character!
WriteInput: DevString
Output: DevVoid
Command used to send a string to the socket.
ReconnectInput: DevVoid
Output: DevVoid
Attempts to re-establish the socket connection.
StatusInput: DevVoid
Output: ConstDevString
Status description
This command gets the device status (stored in its <i>device_status</i> data member) and returns it to the caller.
StateInput: DevVoid
Output: State
State Code
This command gets the device state (stored in its <i>device_state</i> data member) and returns it to the caller.

Pipes:

Properties:

Name Description
AutoReconnectDevBoolean If true, the server try to re-create and re-connect to the socket after a failure. NOTE : The default values is false.
ReadtimeoutDevShort Read timeout in milliseconds.
PortDevLong This is the port number to connect to.
HostnameDevString This is the hostname of the host to connect to.


Please log in to comment.

29 Jun 2019, DS Admin
Updated:
The device class has been updated.
You can see previous version here .



20 Apr 2017, Piotr Goryl
Updated:
The device class has been updated.
You can see previous version here .



23 Feb 2017, Piotr Goryl
Updated:
The device class has been updated.
You can see previous version here .



19 Jan 2017, Piotr Goryl
Updated:
The device server has been updated.
You can see previous version here .



3 Jan 2017, Piotr Goryl
Created:
The device server has been added to catalogue.
Added by:pgoryl2 on:3 Jan 2017, 2:49 p.m.