TCP_Processor (FB) ¶ FUNCTION_BLOCK ABSTRACT TCP_Processor EXTENDS LConC IMPLEMENTS ITCPProcessor Provides the ability to evaluate or manipulate the flow of segments between TCP_Reader and TCP_Writer via the specific implementation of the AsyncAction method. InOut: Scope Name Type Comment Inherited from Input xEnable BOOL TRUE : Activates the defined operation FALSE : Aborts/resets the defined operation LConC Output xBusy BOOL TRUE : Operation is running LConC xError BOOL TRUE : Error condition reached LConC eErrorID ERROR LConC Input Const itfAsyncProperty IAsyncProperty itfSegmentPool ISegmentPool Input itfReader IStream Output itfWriter IStream udiCount UDINT Properties: NonBlocking Methods: SetInitialValue ProcessStream Structure: ITCPProcessor ProcessStream (Method) NonBlocking (Property) SetInitialValue (Method)
TCP_Read (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL TCP_Read EXTENDS LConC This function block serves to read data from the previously established connection given in itfConnection . As long as xEnable is TRUE and the connection is valid. The pointer pData specifies the memory area to write the read data to. udiSize defines the max number of bytes to read. When the data was read successfully, xReady is set to TRUE and udiCount indicates the actually read number of bytes. InOut: Scope Name Type Comment Inherited from Input xEnable BOOL TRUE : Activates the defined operation FALSE : Aborts/resets the defined operation LConC Output xBusy BOOL TRUE : Operation is running LConC xError BOOL TRUE : Error condition reached LConC eErrorID ERROR LConC Input itfConnection IConnection pData __XWORD udiSize UDINT Output xReady BOOL udiCount UDINT
TCP_Reader (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL TCP_Reader EXTENDS LCon Reads the data from the IConnection instance and passes it on via the IStream instance ( itfStream ) in the form of ISegment instances InOut: Scope Name Type Comment Inherited from Input xEnable BOOL TRUE : Activates the defined operation FALSE : Aborts/resets the defined operation LCon Output xDone BOOL Ready condition reached LCon xBusy BOOL TRUE : Operation is running LCon xError BOOL TRUE : Error condition reached LCon eErrorID ERROR LCon Input Const itfAsyncProperty IAsyncProperty itfSegmentPool ISegmentPool Input itfConnection IConnection Output itfStream IStream udiCount UDINT Methods: SetInitialValue Structure: SetInitialValue (Method)
ERROR (ENUM) ¶ TYPE ERROR : Attributes: qualified_only InOut: Name NO_ERROR TIME_OUT PENDING WRONG_CONFIGURATION TASK_CREATION_FAILED EVENT_CREATION_FAILED WRONG_PARAMETER NOT_FROM_A_POOL CONNECTION_ERROR FIONBIO_NOT_POSSIBLE SNI_NOT_POSSIBLE ALREADY_OPENED SEND_ERROR RECEIVE_ERROR CONNECTION_LOST NO_MEMORY ALREADY_ACTIVE NOT_ENABLED WRITE_ERROR READ_ERROR UNKNOWN_HOSTNAME FATAL_ERROR ALREADY_INITIALIZED NOT_SUPPORTED IP_NOT_REACHABLE
OPERATION (ENUM) ¶ TYPE OPERATION : Attributes: qualified_only InOut: Name UNKNOWN SET_OPTION GET_OPTION
PURPOSE (ENUM) ¶ TYPE PURPOSE : Attributes: qualified_only InOut: Name Comment UNKNOWN CLIENT_SIDE Indicates that a TLSContext may be used e.g. to authenticate Web servers (therefore, it will be used to create client-side sockets). SERVER_SIDE Indicates that a TLSContext may be used to authenticate e.g. Web clients (therefore, it will be used to create server-side sockets). CLIENT_SIDE_STARTTLS Indicates that a TLSContext may be used e.g. to authenticate Web servers (therefore, it will be used to create client-side sockets). After a “normal” TCP/IP connection is established this connection can be upgraded to a TLS encrypted connection.
TRANSMISSION (ENUM) ¶ TYPE TRANSMISSION : Attributes: qualified_only InOut: Name Comment UNKOWN UNICAST An one by one communication BROADCAST One communicates with all in the same network SUB_NETWORK_BROADCAST One communicates with all in the same subnetwork MULTICAST One communicates with all in the same group
Function Blocks ¶ AsyncProperty AsyncProperty (Folder) IP IPAddressSet (FunctionBlock) IPv4Address (FunctionBlock) GetIPasByteArray (Method) IIPAddress CompressedIP (Property) ExplodedIP (Property) IPIsGlobal (Property) IPIsLinkLocal (Property) IPIsLoopback (Property) IPIsMultiCast (Property) IPIsPrivate (Property) IPIsReserved (Property) IPIsUnspecified (Property) IPLength (Property) IPVersion (Property) SetInitialValue (Method) PingRequest (FunctionBlock) IActionProvider SampleAction (Method) RequestPing (Method) SetInitialValue (Method) ResolveHostname (FunctionBlock) IActionProvider SampleAction (Method) ResolveHostname (Method) SetInitialValue (Method) TCP TCP_Client (FunctionBlock) IClient Read (Method) SetAdapter (Method) Upgrade (Method) Write (Method) IOptionConsumer SetOptionProvider (Method) SetInitialValue (Method) TCP_Connection (FunctionBlock) IConnection GetClientAddress (Method) Read (Method) Write (Method) TCP_Processor (FunctionBlock) ITCPProcessor ProcessStream (Method) NonBlocking (Property) SetInitialValue (Method) TCP_Read (FunctionBlock) TCP_Reader (FunctionBlock) SetInitialValue (Method) TCP_Server (FunctionBlock) IOptionConsumer SetOptionProvider (Method) SetInitialValue (Method) TCP_Stream CreateSegment (Function) CreateSegmentPool (Function) SegmentPool (FunctionBlock) IDisposable ObjectDispose (Method) ISegmentPool GetSegment (Method) SetInitialValue (Method) Stream (FunctionBlock) IStream Read (Method) Write (Method) TCP_Write (FunctionBlock) TCP_Writer (FunctionBlock) SetInitialValue (Method) TLS TLSContext (FunctionBlock) SetInitialValue (Method) UDP UDP_Packet CreatePacket (Function) CreatePacketPool (Function) PacketPool (FunctionBlock) IPacketPool GetPacket (Method) SetInitialValue (Method) PacketQueue (FunctionBlock) IPacketQueue GetPacket (Method) PutPacket (Method) UDP_Peer (FunctionBlock) IOptionConsumer SetOptionProvider (Method) Receive (Method) Receive2 (Method) Send (Method) SetInitialValue (Method) UDP_Processor (FunctionBlock) IUDPProcessor ProcessPacket (Method) NonBlocking (Property) SetInitialValue (Method) UDP_Receive (FunctionBlock) UDP_Receiver (FunctionBlock) SetInitialValue (Method) UDP_Send (FunctionBlock) UDP_Sender (FunctionBlock) SetInitialValue (Method)
AsyncProperty ¶ AsyncProperty (Folder)
AsyncProperty (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL AsyncProperty IMPLEMENTS IAsyncProperty Structure for defining the properties of a background task InOut: Scope Name Type Initial Comment Input Const tgTaskGroup TASK_GROUP ‘IEC-Tasks’ anAppName APP_NAME ‘Application’ tnTaskName TASK_NAME usiTaskPrio USINT udiTaskInterval UDINT Taskinterval in µs