Operator Reference

HALCON Operator Reference / System / Sockets

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

ClassesClasses | | Operators

get_socket_paramT_get_socket_paramGetSocketParamGetSocketParamget_socket_param (Operator)

get_socket_paramT_get_socket_paramGetSocketParamGetSocketParamget_socket_param — Get the value of a socket parameter.

Signature

get_socket_param( : : Socket, GenParamName : GenParamValue)

Herror T_get_socket_param(const Htuple Socket, const Htuple GenParamName, Htuple* GenParamValue)

void GetSocketParam(const HTuple& Socket, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HSocket::GetSocketParam(const HTuple& GenParamName) const

HTuple HSocket::GetSocketParam(const HString& GenParamName) const

HTuple HSocket::GetSocketParam(const char* GenParamName) const

HTuple HSocket::GetSocketParam(const wchar_t* GenParamName) const   ( Windows only)

static void HOperatorSet.GetSocketParam(HTuple socket, HTuple genParamName, out HTuple genParamValue)

HTuple HSocket.GetSocketParam(HTuple genParamName)

HTuple HSocket.GetSocketParam(string genParamName)

def get_socket_param(socket: HHandle, gen_param_name: MaybeSequence[str]) -> Union[float, int, str]

Description

get_socket_paramget_socket_paramGetSocketParamGetSocketParamget_socket_param reads the GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value of the GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name for the specified socket connection. Available parameters are 'timeout'"timeout""timeout""timeout""timeout", 'address_info'"address_info""address_info""address_info""address_info", 'SO_SNDBUF'"SO_SNDBUF""SO_SNDBUF""SO_SNDBUF""SO_SNDBUF", 'SO_RCVBUF'"SO_RCVBUF""SO_RCVBUF""SO_RCVBUF""SO_RCVBUF", 'SO_BROADCAST'"SO_BROADCAST""SO_BROADCAST""SO_BROADCAST""SO_BROADCAST", and 'TCP_NODELAY'"TCP_NODELAY""TCP_NODELAY""TCP_NODELAY""TCP_NODELAY".

The parameter 'address_info'"address_info""address_info""address_info""address_info" returns the IP address and port of the local and the remote side of the specified socket connection.

See set_socket_paramset_socket_paramSetSocketParamSetSocketParamset_socket_param for a description of the other 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.

Parameters

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

Socket number.

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

Name of the socket parameter.

List of values: 'SO_BROADCAST'"SO_BROADCAST""SO_BROADCAST""SO_BROADCAST""SO_BROADCAST", 'SO_RCVBUF'"SO_RCVBUF""SO_RCVBUF""SO_RCVBUF""SO_RCVBUF", 'SO_SNDBUF'"SO_SNDBUF""SO_SNDBUF""SO_SNDBUF""SO_SNDBUF", 'TCP_NODELAY'"TCP_NODELAY""TCP_NODELAY""TCP_NODELAY""TCP_NODELAY", 'address_info'"address_info""address_info""address_info""address_info", 'timeout'"timeout""timeout""timeout""timeout"

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control)  string → HTupleUnion[float, int, str]HTupleHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong)

Value of the socket parameter.

Possible Predecessors

open_socket_connectopen_socket_connectOpenSocketConnectOpenSocketConnectopen_socket_connect, socket_accept_connectsocket_accept_connectSocketAcceptConnectSocketAcceptConnectsocket_accept_connect

Possible Successors

set_socket_paramset_socket_paramSetSocketParamSetSocketParamset_socket_param

See also

set_socket_paramset_socket_paramSetSocketParamSetSocketParamset_socket_param

Module

Foundation

---

ClassesClasses | | Operators