HALCON Website / HALCON Operator Reference / System / Sockets
ClassesClassesClassesClasses | | | | Operators

get_socket_paramget_socket_paramGetSocketParamget_socket_paramGetSocketParamGetSocketParam (Operator)

Name

get_socket_paramget_socket_paramGetSocketParamget_socket_paramGetSocketParamGetSocketParam — Get the value of a socket parameter.

Signature

get_socket_param( : : Socket, ParamName : ParamValue)

Herror get_socket_param(const Hlong Socket, const char* ParamName, char* ParamValue)

Herror T_get_socket_param(const Htuple Socket, const Htuple ParamName, Htuple* ParamValue)

Herror get_socket_param(const HTuple& Socket, const HTuple& ParamName, char* ParamValue)

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

void GetSocketParam(const HTuple& Socket, const HTuple& ParamName, HTuple* ParamValue)

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

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

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

void HOperatorSetX.GetSocketParam(
[in] VARIANT Socket, [in] VARIANT ParamName, [out] VARIANT* ParamValue)

VARIANT HSocketX.GetSocketParam([in] VARIANT ParamName)

static void HOperatorSet.GetSocketParam(HTuple socket, HTuple paramName, out HTuple paramValue)

HTuple HSocket.GetSocketParam(HTuple paramName)

HTuple HSocket.GetSocketParam(string paramName)

Description

get_socket_paramget_socket_paramGetSocketParamget_socket_paramGetSocketParamGetSocketParam reads the ParamValueParamValueParamValueParamValueParamValueparamValue of the ParamNameParamNameParamNameParamNameParamNameparamName for the specified socket connection. Available parameters are 'timeout'"timeout""timeout""timeout""timeout""timeout", 'address_info'"address_info""address_info""address_info""address_info""address_info", 'SO_SNDBUF'"SO_SNDBUF""SO_SNDBUF""SO_SNDBUF""SO_SNDBUF""SO_SNDBUF", 'SO_RCVBUF'"SO_RCVBUF""SO_RCVBUF""SO_RCVBUF""SO_RCVBUF""SO_RCVBUF", 'SO_BROADCAST'"SO_BROADCAST""SO_BROADCAST""SO_BROADCAST""SO_BROADCAST""SO_BROADCAST", and 'TCP_NODELAY'"TCP_NODELAY""TCP_NODELAY""TCP_NODELAY""TCP_NODELAY""TCP_NODELAY".

The parameter 'address_info'"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_paramSetSocketParamset_socket_paramSetSocketParamSetSocketParam for a description of the other values.

Parallelization

Parameters

SocketSocketSocketSocketSocketsocket (input_control)  socket_id → HSocket, HTupleHTupleHSocket, HTupleHSocketX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Socket number.

ParamNameParamNameParamNameParamNameParamNameparamName (input_control)  string(-array) → HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Name of the socket parameter.

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

ParamValueParamValueParamValueParamValueParamValueparamValue (output_control)  string → HTupleHTupleHTupleVARIANTHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong) (BSTR / double / Hlong) (char* / double / Hlong)

Value of the socket parameter.

Possible Predecessors

open_socket_connectopen_socket_connectOpenSocketConnectopen_socket_connectOpenSocketConnectOpenSocketConnect, socket_accept_connectsocket_accept_connectSocketAcceptConnectsocket_accept_connectSocketAcceptConnectSocketAcceptConnect

Possible Successors

set_socket_paramset_socket_paramSetSocketParamset_socket_paramSetSocketParamSetSocketParam

See also

set_socket_paramset_socket_paramSetSocketParamset_socket_paramSetSocketParamSetSocketParam

Module

Foundation

ClassesClassesClassesClasses | | | | Operators
HALCON Operator Reference 11.0.5 Copyright © 1996-2015 MVTec Software GmbH