Operator Reference

HALCON Operator Reference / System / Sockets

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

ClassesClasses | | Operators

receive_serialized_itemT_receive_serialized_itemReceiveSerializedItemReceiveSerializedItemreceive_serialized_item (Operator)

receive_serialized_itemT_receive_serialized_itemReceiveSerializedItemReceiveSerializedItemreceive_serialized_item — Receive a serialized item over a socket connection.

Signature

receive_serialized_item( : : Socket : SerializedItemHandle)

Herror T_receive_serialized_item(const Htuple Socket, Htuple* SerializedItemHandle)

void ReceiveSerializedItem(const HTuple& Socket, HTuple* SerializedItemHandle)

HSerializedItem HSocket::ReceiveSerializedItem() const

void HSerializedItem::ReceiveSerializedItem(const HSocket& Socket)

static void HOperatorSet.ReceiveSerializedItem(HTuple socket, out HTuple serializedItemHandle)

HSerializedItem HSocket.ReceiveSerializedItem()

void HSerializedItem.ReceiveSerializedItem(HSocket socket)

def receive_serialized_item(socket: HHandle) -> HHandle

Description

receive_serialized_itemreceive_serialized_itemReceiveSerializedItemReceiveSerializedItemreceive_serialized_item receives a serialized item that was sent over the socket connection determined by SocketSocketSocketsocketsocket of another HALCON process using the operator send_serialized_itemsend_serialized_itemSendSerializedItemSendSerializedItemsend_serialized_item (see fwrite_serialized_itemfwrite_serialized_itemFwriteSerializedItemFwriteSerializedItemfwrite_serialized_item for an introduction of the basics of serialization). If no serialized item has been sent, the HALCON process calling receive_serialized_itemreceive_serialized_itemReceiveSerializedItemReceiveSerializedItemreceive_serialized_item 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 SerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle. For a detailed example showing the use of a socket connection, see open_socket_acceptopen_socket_acceptOpenSocketAcceptOpenSocketAcceptopen_socket_accept.

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

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

Socket number.

SerializedItemHandleSerializedItemHandleSerializedItemHandleserializedItemHandleserialized_item_handle (output_control)  serialized_item → HSerializedItem, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the serialized item.

Result

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

Possible Predecessors

send_serialized_itemsend_serialized_itemSendSerializedItemSendSerializedItemsend_serialized_item

Possible Successors

get_serialized_item_ptrget_serialized_item_ptrGetSerializedItemPtrGetSerializedItemPtrget_serialized_item_ptr, deserialize_matrixdeserialize_matrixDeserializeMatrixDeserializeMatrixdeserialize_matrix, deserialize_metrology_modeldeserialize_metrology_modelDeserializeMetrologyModelDeserializeMetrologyModeldeserialize_metrology_model

Module

Foundation

---

ClassesClasses | | Operators