mvm_gui_try_get_messageT_mvm_gui_try_get_messageMvmGuiTryGetMessageMvmGuiTryGetMessage (Operator)

Name

mvm_gui_try_get_messageT_mvm_gui_try_get_messageMvmGuiTryGetMessageMvmGuiTryGetMessage — Try to get a message from the message loop of a server.

Signature

mvm_gui_try_get_message( : PayloadObject : ServerHandle : ConnectionHandle, Id, PayloadClass, PayloadTuple)

Description

Try to get a message from the message loop of a server. This is a non-blocking call that returns immediately. In error cases or if no message is available, an empty ConnectionHandleConnectionHandleConnectionHandleConnectionHandleconnectionHandle and empty IdIdIdIdid will be returned. If a payload is attached to this message (see parameter PayloadClassPayloadClassPayloadClassPayloadClasspayloadClass), the payload is returned in PayloadObjectPayloadObjectPayloadObjectPayloadObjectpayloadObject or PayloadTuplePayloadTuplePayloadTuplePayloadTuplepayloadTuple. Returned tuples in PayloadTuplePayloadTuplePayloadTuplePayloadTuplepayloadTuple may be an empty array or an array containing only integers, floats, or strings. Especially, the sender is not allowed to send for example null, an array of arrays or undefined values.

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.

This operator modifies the state of the following input parameter:

ServerHandleServerHandleServerHandleServerHandleserverHandle

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

PayloadObjectPayloadObjectPayloadObjectPayloadObjectpayloadObject (output_object) image(-array) → object

object payload if PayloadClass is 'image', 'region', 'xld_cont', 'xld_poly', or 'xld_parallel'

ServerHandleServerHandleServerHandleServerHandleserverHandle (input_control, state is modified) serial → (handle)

GUI server handle

ConnectionHandleConnectionHandleConnectionHandleConnectionHandleconnectionHandle (output_control) socket → (handle)

the connection handle corresponding to the message. Might be empty if an error occurred.

IdIdIdIdid (output_control) proc_name → (string)

a GUI Id. Predefined messages start with __.

PayloadClassPayloadClassPayloadClassPayloadClasspayloadClass (output_control) string → (string)

class of the attached payload. May be 'none', 'tuple', 'image', 'region', 'xld_cont', 'xld_poly', or 'xld_parallel'

PayloadTuplePayloadTuplePayloadTuplePayloadTuplepayloadTuple (output_control) integer(-array) → (string / integer / real)

tuple payload if PayloadClass is 'tuple'

Module

Foundation

Operators