Operator Reference

HALCON Operator Reference / System / Sockets

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

receive_dataT_receive_dataReceiveDataReceiveDatareceive_data (Operator)

receive_dataT_receive_dataReceiveDataReceiveDatareceive_data — Receive arbitrary data from external devices or applications using a generic socket connection.

Signature

receive_data( : : Socket, Format : Data, From)

Herror T_receive_data(const Htuple Socket, const Htuple Format, Htuple* Data, Htuple* From)

void ReceiveData(const HTuple& Socket, const HTuple& Format, HTuple* Data, HTuple* From)

HTuple HSocket::ReceiveData(const HTuple& Format, HTuple* From) const

HTuple HSocket::ReceiveData(const HString& Format, HString* From) const

HTuple HSocket::ReceiveData(const char* Format, HString* From) const

HTuple HSocket::ReceiveData(const wchar_t* Format, HString* From) const   ( Windows only)

static void HOperatorSet.ReceiveData(HTuple socket, HTuple format, out HTuple data, out HTuple from)

HTuple HSocket.ReceiveData(HTuple format, out HTuple from)

HTuple HSocket.ReceiveData(string format, out string from)

def receive_data(socket: HHandle, format: MaybeSequence[str]) -> Tuple[HTupleElementType, Union[int, str]]

Description

receive_datareceive_dataReceiveDataReceiveDatareceive_data receives arbitrary data over a generic socket connection. The received data is converted from a binary network packet to a value (or a tuple of values) using the parameter FormatFormatFormatformatformat as specification and is well-suited to communicate with external devices or applications. This operator does not support the standard 'HALCON'"HALCON""HALCON""HALCON""HALCON" protocol, but is intended for arbitrary data transfer.

The received data is converted to a value or tuple of values using the parameter FormatFormatFormatformatformat. It is possible to specify multiple formats. In this case the FromFromFromfromfrom parameter will contain a 3rd value which tells you which format has been used to convert the data. To decide which format to use the size of the necessary data for each format is calculated initially. When data is received, the first format string with the matching size is used to convert the data to values.

The parameter FromFromFromfromfrom contains the IP address or hostname and port of the communication partner. For UDP connections it can be used in the send_datasend_dataSendDataSendDatasend_data operator to send a response.

Please see send_datasend_dataSendDataSendDatasend_data for a detailed description of the format.

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

SocketSocketSocketsocketsocket (input_control)  socket → HSocket, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Socket number.

FormatFormatFormatformatformat (input_control)  string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Specification how to convert the data to tuples.

Default: 'z' "z" "z" "z" "z"

DataDataDatadatadata (output_control)  string → HTupleHTupleElementTypeHTupleHtuple (string / real / integer / handle) (string / double / int / long / HHandle) (HString / double / Hlong / HHandle) (char* / double / Hlong / handle)

Value (or tuple of values) holding the received and converted data.

FromFromFromfromfrom (output_control)  string → HTupleUnion[int, str]HTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)

IP address or hostname and network port of the communication partner.

Possible Predecessors

open_socket_connectopen_socket_connectOpenSocketConnectOpenSocketConnectopen_socket_connect, socket_accept_connectsocket_accept_connectSocketAcceptConnectSocketAcceptConnectsocket_accept_connect, get_socket_paramget_socket_paramGetSocketParamGetSocketParamget_socket_param, set_socket_paramset_socket_paramSetSocketParamSetSocketParamset_socket_param

Possible Successors

close_socketclose_socketCloseSocketCloseSocketclose_socket

See also

send_datasend_dataSendDataSendDatasend_data

Module

Foundation

---

ClassesClasses | | Operators