HALCON 20.11.0.0 / HALCON Operator Reference / System / Sockets
ClassesClasses | | Operators

set_socket_paramT_set_socket_paramSetSocketParamSetSocketParamset_socket_param (Operator)

Name

set_socket_paramT_set_socket_paramSetSocketParamSetSocketParamset_socket_param — Set a socket parameter.

Signature

set_socket_param( : : Socket, GenParamName, GenParamValue : )

Herror T_set_socket_param(const Htuple Socket, const Htuple GenParamName, const Htuple GenParamValue)

void SetSocketParam(const HTuple& Socket, const HTuple& GenParamName, const HTuple& GenParamValue)

void HSocket::SetSocketParam(const HTuple& GenParamName, const HTuple& GenParamValue) const

void HSocket::SetSocketParam(const HString& GenParamName, const HString& GenParamValue) const

void HSocket::SetSocketParam(const char* GenParamName, const char* GenParamValue) const

void HSocket::SetSocketParam(const wchar_t* GenParamName, const wchar_t* GenParamValue) const   (Windows only)

static void HOperatorSet.SetSocketParam(HTuple socket, HTuple genParamName, HTuple genParamValue)

void HSocket.SetSocketParam(HTuple genParamName, HTuple genParamValue)

void HSocket.SetSocketParam(string genParamName, string genParamValue)

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

Description

set_socket_paramset_socket_paramSetSocketParamSetSocketParamSetSocketParamset_socket_param sets the GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name according to GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value for the specified socket connection. Available parameters are 'timeout'"timeout""timeout""timeout""timeout""timeout", '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 'timeout'"timeout""timeout""timeout""timeout""timeout" can be used to set a timeout for this socket. The timeout is given in seconds as a floating point number or as the string 'infinite'"infinite""infinite""infinite""infinite""infinite".

The parameters starting with 'SO_' or 'TCP_' set the corresponding socket options. 'SO_SNDBUF'"SO_SNDBUF""SO_SNDBUF""SO_SNDBUF""SO_SNDBUF""SO_SNDBUF" and 'SO_RCVBUF'"SO_RCVBUF""SO_RCVBUF""SO_RCVBUF""SO_RCVBUF""SO_RCVBUF" specify the size of the send respectively receive buffer of the operating system for this socket. Please be aware that this does not mean the size of one network packet but the size of the buffers where all packets are temporarily stored by your operating system. 'SO_BROADCAST'"SO_BROADCAST""SO_BROADCAST""SO_BROADCAST""SO_BROADCAST""SO_BROADCAST" can only be used together with UDP connections and enables broadcasting of network packets. 'TCP_NODELAY'"TCP_NODELAY""TCP_NODELAY""TCP_NODELAY""TCP_NODELAY""TCP_NODELAY" controls the Nagle algorithm, which optimizes the flow of small TCP packets and can only be used with TCP connections.

Execution Information

Parameters

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

Socket number.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_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_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", 'timeout'"timeout""timeout""timeout""timeout""timeout"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control)  string(-array) → HTupleMaybeSequence[Union[float, int, str]]HTupleHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong)

Value of the socket parameter.

Default value: 'on' "on" "on" "on" "on" "on"

Suggested values: 'on'"on""on""on""on""on", 'off'"off""off""off""off""off", 0, 1, 3.0, 'infinite'"infinite""infinite""infinite""infinite""infinite", 530, 1460

Possible Predecessors

open_socket_connectopen_socket_connectOpenSocketConnectOpenSocketConnectOpenSocketConnectopen_socket_connect, socket_accept_connectsocket_accept_connectSocketAcceptConnectSocketAcceptConnectSocketAcceptConnectsocket_accept_connect

Possible Successors

send_datasend_dataSendDataSendDataSendDatasend_data, receive_datareceive_dataReceiveDataReceiveDataReceiveDatareceive_data

See also

get_socket_paramget_socket_paramGetSocketParamGetSocketParamGetSocketParamget_socket_param

Module

Foundation

ClassesClasses | | Operators
HALCON Operator Reference 20.11.0.0 Copyright © 1996-2020 MVTec Software GmbH