open_socket_connectT_open_socket_connectOpenSocketConnectOpenSocketConnectopen_socket_connect (Operator)
Name
open_socket_connectT_open_socket_connectOpenSocketConnectOpenSocketConnectopen_socket_connect — Open a socket and connect it to an accepting socket.
Signature
void OpenSocketConnect(const HTuple& HostName, const HTuple& Port, const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* Socket)
void HSocket::HSocket(const HString& HostName, Hlong Port, const HTuple& GenParamName, const HTuple& GenParamValue)
void HSocket::HSocket(const HString& HostName, Hlong Port, const HString& GenParamName, const HString& GenParamValue)
void HSocket::HSocket(const char* HostName, Hlong Port, const char* GenParamName, const char* GenParamValue)
void HSocket::HSocket(const wchar_t* HostName, Hlong Port, const wchar_t* GenParamName, const wchar_t* GenParamValue)
(
Windows only)
void HSocket::OpenSocketConnect(const HString& HostName, Hlong Port, const HTuple& GenParamName, const HTuple& GenParamValue)
void HSocket::OpenSocketConnect(const HString& HostName, Hlong Port, const HString& GenParamName, const HString& GenParamValue)
void HSocket::OpenSocketConnect(const char* HostName, Hlong Port, const char* GenParamName, const char* GenParamValue)
void HSocket::OpenSocketConnect(const wchar_t* HostName, Hlong Port, const wchar_t* GenParamName, const wchar_t* GenParamValue)
(
Windows only)
static void HOperatorSet.OpenSocketConnect(HTuple hostName, HTuple port, HTuple genParamName, HTuple genParamValue, out HTuple socket)
public HSocket(string hostName, int port, HTuple genParamName, HTuple genParamValue)
public HSocket(string hostName, int port, string genParamName, string genParamValue)
void HSocket.OpenSocketConnect(string hostName, int port, HTuple genParamName, HTuple genParamValue)
void HSocket.OpenSocketConnect(string hostName, int port, string genParamName, string genParamValue)
Description
open_socket_connectopen_socket_connectOpenSocketConnectOpenSocketConnectopen_socket_connect opens a connecting socket to an accepting
socket on the computer HostNameHostNameHostNamehostNamehost_name, which listens on port
PortPortPortportport.
The following parameters can be set for GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name.
- 'protocol'"protocol""protocol""protocol""protocol":
-
Specifies the protocol to be used. The 'HALCON'"HALCON""HALCON""HALCON""HALCON" protocol without
a specific address family, will use IPv4 or IPv6 automatically depending
on the network configuration of the computer. To use a specific address
family a '4' or '6' (for IPv4 or IPv6, respectively) must be appended to
the name of the protocol. For example, 'HALCON4'"HALCON4""HALCON4""HALCON4""HALCON4" designates a
HALCON connection over IPv4. Possible values for a generic socket
communication are 'UDP'"UDP""UDP""UDP""UDP" and 'TCP'"TCP""TCP""TCP""TCP" which also support
appended '4' and '6'. Alternatively, the usage of addresses for
IPv4 (e.g., '127.0.0.1'"127.0.0.1""127.0.0.1""127.0.0.1""127.0.0.1") or IPv6 (e.g., '::1'"::1""::1""::1""::1")
for HostNameHostNameHostNamehostNamehost_name determines the address family to be used.
Both communication partners must use the same protocol.
To exchange data using generic sockets use send_datasend_dataSendDataSendDatasend_data and
receive_datareceive_dataReceiveDataReceiveDatareceive_data only.
Default:
'HALCON'"HALCON""HALCON""HALCON""HALCON"
- 'timeout'"timeout""timeout""timeout""timeout":
-
Sets a timeout for this operation. The timeout is given in seconds or
as the string 'infinite'"infinite""infinite""infinite""infinite".
- 'tls_enable'"tls_enable""tls_enable""tls_enable""tls_enable":
-
Controls the use of Transport Layer Security (TLS) for the new socket
connection. When 'tls_enable'"tls_enable""tls_enable""tls_enable""tls_enable" is set to 'true'"true""true""true""true", a
connection attempt using TLS is undertaken. This requires TLS support on
the server side. The certificate to optionally check against is specified
with the generic parameter 'tls_certificate'"tls_certificate""tls_certificate""tls_certificate""tls_certificate". Without a
certificate, the connection will still be encrypted, but the authenticity
of the server can not be verified.
Default:
'false'"false""false""false""false"
- 'tls_certificate'"tls_certificate""tls_certificate""tls_certificate""tls_certificate":
-
Specify the path to a certificate to check the authenticity of the server
of connection using Transport Layer Security (TLS). The certificate must
be provided in PEM-format. This parameter is ignored if
'tls_enable'"tls_enable""tls_enable""tls_enable""tls_enable" is not set to 'true'"true""true""true""true".
- 'tsl_sni'"tsl_sni""tsl_sni""tsl_sni""tsl_sni":
-
Set the “server name indication” to use for the TLS connection. This
tells the server for which domain the certificate should be valid, which
is important if multiple domains are hosted on the same server. This
parameter is ignored if 'tls_enable'"tls_enable""tls_enable""tls_enable""tls_enable" is not set to 'true'"true""true""true""true".
- 'string_encoding'"string_encoding""string_encoding""string_encoding""string_encoding":
-
Sets the string encoding that is expected when sending and receiving
strings with this socket. It is used for send_tuplesend_tupleSendTupleSendTuplesend_tuple and
receive_tuplereceive_tupleReceiveTupleReceiveTuplereceive_tuple as well as send_datasend_dataSendDataSendDatasend_data and receive_datareceive_dataReceiveDataReceiveDatareceive_data.
When the protocol 'HALCON'"HALCON""HALCON""HALCON""HALCON" is used, the setting only has effect
on connections to HALCON versions prior to 18.11. If the connection
partner is detected to have HALCON version 18.11 or newer, UTF-8 is
used to encode tuples.
For the 'HALCON'"HALCON""HALCON""HALCON""HALCON" protocol the listening socket must have been
created earlier with the operator open_socket_acceptopen_socket_acceptOpenSocketAcceptOpenSocketAcceptopen_socket_accept in another
HALCON process. To establish the connection, the HALCON process, in which the
accepting socket resides, must call socket_accept_connectsocket_accept_connectSocketAcceptConnectSocketAcceptConnectsocket_accept_connect. For a
detailed example, see open_socket_acceptopen_socket_acceptOpenSocketAcceptOpenSocketAcceptopen_socket_accept.
For generic sockets the socket to connect to can be any socket from the
same protocol type.
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
HostNameHostNameHostNamehostNamehost_name (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Hostname of the computer to connect to.
Default:
'localhost'
"localhost"
"localhost"
"localhost"
"localhost"
PortPortPortportport (input_control) number → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Port number.
Suggested values:
3000, 4570
Value range:
1024
≤
Port
Port
Port
port
port
≤
65535
Minimum increment:
1
Recommended increment:
1
GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Names of the generic parameters that can be
adjusted for the socket.
Default:
[]
List of values:
'protocol'"protocol""protocol""protocol""protocol", 'string_encoding'"string_encoding""string_encoding""string_encoding""string_encoding", 'timeout'"timeout""timeout""timeout""timeout", 'tls_certificate'"tls_certificate""tls_certificate""tls_certificate""tls_certificate", 'tls_enable'"tls_enable""tls_enable""tls_enable""tls_enable", 'tls_sni'"tls_sni""tls_sni""tls_sni""tls_sni"
GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control) attribute.value(-array) → HTupleMaybeSequence[Union[float, int, str]]HTupleHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong)
Values of the generic parameters that can be
adjusted for the socket.
Default:
[]
Suggested values:
0, 3.0, 'infinite'"infinite""infinite""infinite""infinite", 'HALCON'"HALCON""HALCON""HALCON""HALCON", 'UDP'"UDP""UDP""UDP""UDP", 'TCP'"TCP""TCP""TCP""TCP", 'HALCON4'"HALCON4""HALCON4""HALCON4""HALCON4", 'UDP4'"UDP4""UDP4""UDP4""UDP4", 'TCP4'"TCP4""TCP4""TCP4""TCP4", 'HALCON6'"HALCON6""HALCON6""HALCON6""HALCON6", 'UDP6'"UDP6""UDP6""UDP6""UDP6", 'TCP6'"TCP6""TCP6""TCP6""TCP6", 'utf8'"utf8""utf8""utf8""utf8", 'locale'"locale""locale""locale""locale", 'ignore'"ignore""ignore""ignore""ignore", 'true'"true""true""true""true", 'false'"false""false""false""false"
SocketSocketSocketsocketsocket (output_control) socket → HSocket, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Socket number.
Possible Successors
send_imagesend_imageSendImageSendImagesend_image,
receive_imagereceive_imageReceiveImageReceiveImagereceive_image,
send_regionsend_regionSendRegionSendRegionsend_region,
receive_regionreceive_regionReceiveRegionReceiveRegionreceive_region,
send_tuplesend_tupleSendTupleSendTuplesend_tuple,
receive_tuplereceive_tupleReceiveTupleReceiveTuplereceive_tuple,
send_datasend_dataSendDataSendDatasend_data,
receive_datareceive_dataReceiveDataReceiveDatareceive_data
See also
open_socket_acceptopen_socket_acceptOpenSocketAcceptOpenSocketAcceptopen_socket_accept,
socket_accept_connectsocket_accept_connectSocketAcceptConnectSocketAcceptConnectsocket_accept_connect,
get_socket_paramget_socket_paramGetSocketParamGetSocketParamget_socket_param,
set_socket_paramset_socket_paramSetSocketParamSetSocketParamset_socket_param,
close_socketclose_socketCloseSocketCloseSocketclose_socket
Module
Foundation