HALCON Reference Manual 10.0.2
Table of Contents / System / Sockets ClassesClassesClasses | | | Operators

open_socket_acceptopen_socket_acceptopen_socket_acceptOpenSocketAcceptOpenSocketAccept (Operator)

Name

open_socket_acceptopen_socket_acceptopen_socket_acceptOpenSocketAcceptOpenSocketAccept — Open a socket that accepts connection requests.

Signature

open_socket_accept( : : Port, GenParamName, GenParamValue : AcceptingSocket)

Herror open_socket_accept(const Hlong Port, const char* GenParamName, const char* GenParamValue, Hlong* AcceptingSocket)

Herror T_open_socket_accept(const Htuple Port, const Htuple GenParamName, const Htuple GenParamValue, Htuple* AcceptingSocket)

Herror open_socket_accept(const HTuple& Port, const HTuple& GenParamName, const HTuple& GenParamValue, Hlong* AcceptingSocket)

void HSocket::OpenSocketAccept(const HTuple& Port, const HTuple& GenParamName, const HTuple& GenParamValue)

void HOperatorSetX.OpenSocketAccept(
[in] VARIANT Port, [in] VARIANT GenParamName, [in] VARIANT GenParamValue, [out] VARIANT* AcceptingSocket)

void HSocketX.OpenSocketAccept(
[in] Hlong Port, [in] VARIANT GenParamName, [in] VARIANT GenParamValue)

static void HOperatorSet.OpenSocketAccept(HTuple port, HTuple genParamName, HTuple genParamValue, out HTuple acceptingSocket)

public HSocket(int port, HTuple genParamName, HTuple genParamValue)

public HSocket(int port, string genParamName, string genParamValue)

void HSocket.OpenSocketAccept(int port, HTuple genParamName, HTuple genParamValue)

void HSocket.OpenSocketAccept(int port, string genParamName, string genParamValue)

Description

open_socket_acceptopen_socket_acceptopen_socket_acceptOpenSocketAcceptOpenSocketAccept opens a socket that will accept incoming connection requests. This operator is the necessary first step in the establishment of a communication channel between two HALCON processes. The socket listens for incoming connection requests on the port number given by PortPortPortPortport.

The generic parameter 'protocol'"protocol""protocol""protocol""protocol" may be used to specify also a generic protocol. Possible values for generic socket communication are 'UDP'"UDP""UDP""UDP""UDP" and 'TCP'"TCP""TCP""TCP""TCP". The default is the 'HALCON'"HALCON""HALCON""HALCON""HALCON" protocol. To exchange data using generic sockets only send_datasend_datasend_dataSendDataSendData and receive_datareceive_datareceive_dataReceiveDataReceiveData are available. To explicitly specify IPv4 or IPv6 connections you can append a '4' or '6' to the protocol, e.g., 'UDP6'"UDP6""UDP6""UDP6""UDP6" means a generic UDP connection using IPv6.

The generic parameter 'timeout'"timeout""timeout""timeout""timeout" can be used to set a timeout for this socket. The timeout is given in seconds or as the string 'infinite'"infinite""infinite""infinite""infinite". It is used especially as timeout and waiting mode in a following socket_accept_connectsocket_accept_connectsocket_accept_connectSocketAcceptConnectSocketAcceptConnect call with the parameter Wait set to 'auto'"auto""auto""auto""auto".

The accepting socket is returned in AcceptingSocketAcceptingSocketAcceptingSocketAcceptingSocketacceptingSocket. open_socket_acceptopen_socket_acceptopen_socket_acceptOpenSocketAcceptOpenSocketAccept returns immediately without waiting for a request from another process, which must be initiated by calling open_socket_connectopen_socket_connectopen_socket_connectOpenSocketConnectOpenSocketConnect. This allows multiple other processes to connect to the particular HALCON process that calls open_socket_acceptopen_socket_acceptopen_socket_acceptOpenSocketAcceptOpenSocketAccept. To accept an incoming 'HALCON'"HALCON""HALCON""HALCON""HALCON" or 'TCP'"TCP""TCP""TCP""TCP" connection request, socket_accept_connectsocket_accept_connectsocket_accept_connectSocketAcceptConnectSocketAcceptConnect must be called to obtain a socket for the final communication.

Parallelization

Parameters

PortPortPortPortport (input_control)  number HTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong)

Port number.

Default value: 3000

Suggested values: 3000, 4570

Typical range of values: 1024 ≤ Port Port Port Port port ≤ 65535

Minimum increment: 1

Recommended increment: 1

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  attribute.name(-array) HTupleHTupleVARIANTHtuple (string) (string) (char*) (BSTR) (char*)

Names of the generic parameters that can be adjusted for the socket.

Default value: []

List of values: 'timeout'"timeout""timeout""timeout""timeout", 'protocol'"protocol""protocol""protocol""protocol"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (input_control)  attribute.name(-array) HTupleHTupleVARIANTHtuple (string / real / integer) (string / double / int / long) (char* / double / Hlong) (BSTR / double / Hlong) (char* / double / Hlong)

Values of the generic parameters that can be adjusted for the socket.

Default value: []

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"

AcceptingSocketAcceptingSocketAcceptingSocketAcceptingSocketacceptingSocket (output_control)  socket_id HSocket, HTupleHSocket, HTupleHSocketX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong)

Socket number.

Example (HDevelop)

* Process 1
dev_set_colored (12)
open_socket_accept (3000, [], [], AcceptingSocket)
* Busy wait for an incoming connection
dev_error_var (Error, 1)
dev_set_check ('~give_error')
OpenStatus := 5
while (OpenStatus # 2)
    socket_accept_connect (AcceptingSocket, 'false', Socket)
    OpenStatus := Error
    wait_seconds (0.2)
endwhile
dev_set_check ('give_error')
* Connection established
receive_image (Image, Socket)
threshold (Image, Region, 0, 63)
send_region (Region, Socket)
receive_region (ConnectedRegions, Socket)
area_center (ConnectedRegions, Area, Row, Column)
send_tuple (Socket, Area)
send_tuple (Socket, Row)
send_tuple (Socket, Column)
close_socket (Socket)
close_socket (AcceptingSocket)

* Process 2
dev_set_colored (12)
open_socket_connect ('localhost', 3000, [], [], Socket)
read_image (Image, 'fabrik')
send_image (Image, Socket)
receive_region (Region, Socket)
connection (Region, ConnectedRegions)
send_region (ConnectedRegions, Socket)
receive_tuple (Socket, Area)
receive_tuple (Socket, Row)
receive_tuple (Socket, Column)
close_socket (Socket)

Possible Successors

socket_accept_connectsocket_accept_connectsocket_accept_connectSocketAcceptConnectSocketAcceptConnect

See also

open_socket_connectopen_socket_connectopen_socket_connectOpenSocketConnectOpenSocketConnect, close_socketclose_socketclose_socketCloseSocketCloseSocket, get_socket_paramget_socket_paramget_socket_paramGetSocketParamGetSocketParam, set_socket_paramset_socket_paramset_socket_paramSetSocketParamSetSocketParam, send_imagesend_imagesend_imageSendImageSendImage, receive_imagereceive_imagereceive_imageReceiveImageReceiveImage, send_regionsend_regionsend_regionSendRegionSendRegion, receive_regionreceive_regionreceive_regionReceiveRegionReceiveRegion, send_tuplesend_tuplesend_tupleSendTupleSendTuple, receive_tuplereceive_tuplereceive_tupleReceiveTupleReceiveTuple, send_datasend_datasend_dataSendDataSendData, receive_datareceive_datareceive_dataReceiveDataReceiveData

Module

Foundation


Table of Contents / System / Sockets ClassesClassesClasses | | | Operators
HALCON Reference Manual 10.0.2 Copyright © 1996-2011 MVTec Software GmbH