Skip to content

receive_serialized_itemReceiveSerializedItemReceiveSerializedItemreceive_serialized_itemT_receive_serialized_item🔗

Short description🔗

receive_serialized_itemReceiveSerializedItemReceiveSerializedItemreceive_serialized_itemT_receive_serialized_item — Receive a serialized item over a socket connection.

Signature🔗

receive_serialized_item( socket Socket, out serialized_item SerializedItemHandle )void ReceiveSerializedItem( const HTuple& Socket, HTuple* SerializedItemHandle )static void HOperatorSet.ReceiveSerializedItem( HTuple socket, out HTuple serializedItemHandle )def receive_serialized_item( socket: HHandle ) -> HHandle

Herror T_receive_serialized_item( const Htuple Socket, Htuple* SerializedItemHandle )

HSerializedItem HSocket::ReceiveSerializedItem( ) const

void HSerializedItem::ReceiveSerializedItem( const HSocket& Socket )

HSerializedItem HSocket.ReceiveSerializedItem( )

void HSerializedItem.ReceiveSerializedItem( HSocket socket )

Description🔗

receive_serialized_itemReceiveSerializedItem receives a serialized item that was sent over the socket connection determined by Socketsocketsocket of another HALCON process using the operator send_serialized_itemSendSerializedItem (see fwrite_serialized_itemFwriteSerializedItem for an introduction of the basics of serialization). If no serialized item has been sent, the HALCON process calling receive_serialized_itemReceiveSerializedItem blocks until enough data arrives. The data is stored in a new created serialized item. The operator returns the handle of the serialized item in parameter SerializedItemHandleserializedItemHandleserialized_item_handle. For a detailed example showing the use of a socket connection, see open_socket_acceptOpenSocketAccept.

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters🔗

Socketsocketsocket (input_control) socket → (handle)HTuple (HHandle)HSocket, HTuple (IntPtr)HHandleHtuple (handle)

Socket number.

SerializedItemHandleserializedItemHandleserialized_item_handle (output_control) serialized_item → (handle)HTuple (HHandle)HSerializedItem, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the serialized item.

Result🔗

If the parameters are valid, the operator receive_serialized_itemReceiveSerializedItem returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

send_serialized_itemSendSerializedItem

Possible successors

get_serialized_item_ptrGetSerializedItemPtr, deserialize_matrixDeserializeMatrix, deserialize_metrology_modelDeserializeMetrologyModel

Module🔗

Foundation