Dart SecureTcp, SecureServer Controls
SecureTcp Object Members
Overview 
Public Methods
Public Method AbortAbort any blocking method and release all system resources.
Public Method AboutShow the About Box.
Public Method ClearCertificateClears the Certificate Property
Public Method CloseClose the session and release all system resources. A single control can be used for many connections, one after the other.
Public Method ConnectEstablish a secure connection. The State property immediately changes to tcpConnecting and changes to tcpConnected when the connection is established, the security protocol is negotiated and authentication succeeds. The State property can be checked in the body of the State Event, polled off a timer, or checked immediately after this method is used when a positive Timeout is specified.
Public Method FillUse this method when you know exactly how many bytes or characters you want from the TCP stream. Data is either filled to capacity or no data is returned. This method is useful for processing fixed-length records that can include binary structures.
Public Method ReceiveReceive an arbitrary amount of data. The specified String or Byte array is filled with bytes from the remote host.
Public Method Search

Receive data up to and including a terminating sequence. The data stream is searched for the specified Token, and the specified string, byte array, or DartStream object is filled with the data stream up to and including the specified Token.

This method is useful for processing variable-length records or lines that are defined by known delimiter strings.

Public Method SendSend data after a connection is established. The Send event fires when data is accepted by the system. The SendBufferCount property always indicates the number of bytes that have been submitted but have not yet been accepted by the system.
Public Method Trace

Start or stop the accumulation of trace or debug data. Once started, this method accumulates data until it is turned off.

This method provides a convenient mechanism for viewing all data being sent and received over the connection and can be used to troubleshoot host interoperability issues and expose protocol communications.

Public Properties
Public Property BlockedA True value indicates the control is currently executing a blocking method (Timeout is greater than 0), which has neither completed nor timed out with a ptTimeout error.
Public Property CertificateCertificate Object to use when authenticating to the remote host
Public Property ClientAuthenticationRequest that the client authenticate itself, only applies to server operation.
Public Property IpV6Specifies whether hostname addresses should be favorably resolved to IPv6.
Public Property KeepAliveWhen set to True, the KEEPALIVE socket option is set to monitor dropped connections. This option can only be set when the State property is tcpConnected.
Public Property LocalAddressWhen the State property is tcpConnected, returns the IP address of the local host. When not connected, returns an empty string.
Public Property LocalPortWhen the State property is tcpConnected, returns the port number that the socket is bound to. When not connected, returns 0.
Public Property NoDelayWhen True, the NODELAY socket option is set to defeat Nagle's algorithm.
Public Property ProtocolSpecifies the security protocol used.
Public Property ProxyHostSpecifies the name or address of the proxy server that requests are to be routed through.
Public Property ProxyPasswordPassword to be sent on all requests through a proxy server that requires authentication.
Public Property ProxyPortSpecifies the port used by proxy server that requests are to be routed through.
Public Property ProxyTypeThe type of proxy server used for this connection.
Public Property ProxyUsernameUsername to be sent on all requests through a proxy server that requires authentication.
Public Property ReceiveBufferCountThe number of bytes available for receiving.
Public Property ReceiveBufferSizeNumber of bytes the system has for buffering incoming data.
Public Property RefStores a reference to another object, data type, or value.
Public Property RemoteAddressReturns the IP address of the remote host when the State property is tcpConnected.
Public Property RemoteCertificateContains certificate credentials provided by remote host
Public Property RemotePortReturns the port number of the remote host when the State property is tcpConnected.
Public Property ReuseAddressWhen True, the REUSEADDR socket option is set to accept duplicate use of the same LocalAddress / LocalPort pair (these are optional parameters of the Connect and Listen methods). If used, this property must be set prior to calling the Connect or Listen method and can be set at design time.
Public Property SecuritySets the security level during communication.
Public Property SendBufferCountWhen the Send method is used, some data may be stored in a buffer and later submitted to the system. The Send event fires to indicate that the system has accepted the submitted data.
Public Property SendBufferSizeNumber of bytes the system uses for buffering outgoing data.
Public Property SessionNameUsed to control session caching when consecutive secure connections are made to the same server.
Public Property SocketSystem identifier assigned to the TCP connection. It is normally used to assume management of a socket accepted from the Daemon Control.
Public Property StateProvides status information to the user interface. The State event fires to signal that this property has changed.
Public Property TimeoutControls the blocking behavior of methods that can be used in blocking and non-blocking ways.
Public Property UseSslShutdownSpecifies use of SSL Shutdown handshaking before closing.
Events
Public Event AuthenticateFires when the remote host has sent a certificate to be authenticated.
Public Event CertificateFires when the remote host is requesting a certificate and the Certificate property is not set to a valid Certificate Object.
Public Event ErrorFires when an error condition occurs.
Public Event ReceiveFires when ReceiveBufferCount changes.
Public Event SendFires when the system accepts data for sending.
Public Event StateThe State Property has changed
See Also

SecureTcp Object


PowerTCP SSL for ActiveX Documentation Version 2.2.1
© 2018 Dart Communications. All Rights Reserved.
Send comments on this topic