TWSocket
Main page -> ICS component reference -> TWSocket
Contents
Overview
| unit | OverbyteIcsWSocket.pas | |
| inheritance |
TWSocket component is implementing the TCP protocol described in RFC 793 and the UDP protocol described in RFC 768. TWSocket is used in almost every other ICS component.
TWSocket component can be used as client as well as a Server socket (listening). For its use as TCP server however TWSocketServer is encouraged because of his advanced features.
Properties
| Addr | Client: The host to connect to. Server: The interface to listen on. | |
| AllSent | Boolean telling if all data in internal buffer has been sent. | |
| BufSize | Size in bytes for dynamic send buffer cells. | |
| ComponentOptions | Used to modify how the component handle some operations. | |
| DnsResult | Typically called in OnDnsLookupDone. The IP address of the remote host given as argument to DnsLookup. | |
| DnsResultList | Similar to DnsResult but a TStringList containing the multiple IP's of the host if appropriate. | |
| Handle | Handle for the underlaying hidden window. | |
| HSocket | Winsock handle for underlaying socket. | |
| IcsLogger | Linked component to log debug messages. | |
| LastError | Save the last error occured during socket operation. | |
| LineEcho | Echo all received characters back to transmitter. | |
| LineEdit | Handle received control characters used for editing. | |
| LineEnd | End of line character(s) used ot trigger OnDataAvailable. | |
| LineLength | When using LineMode: the length of the received line. | |
| LineLimit | Maximum line lenght to receive before triggering OnLineLimitExceeded. See also DOS attack. | |
| LineMode | Use LineEnd as end of line marker to trigger OnDataAvailable. | |
| LingerOnOff | Select linger mode. | |
| LingerTimeout | Select linger timeout. | |
| ListenBacklog | Size of pending connection queue in server mode. | |
| LocalAddr | The local address where the socket is bound to. | |
| LocalPort | The local port where the socket is bound to. | |
| MultiCast | Select multicast. | |
| MultiCastAddrStr | Select multicast address. | |
| MultiCastIpTTL | Select multicast Time To Live. | |
| MultiThreaded | Set when TWSocket has to use his own message pump. | |
| PeerAddr | The remote address where the socket is bound to. | |
| PeerPort | The remote port port where the socket is bound to. | |
| Port | Client: The port to connect to. Server: The port to listen on. | |
| PortNum | Integer value of Port. | |
| Proto | The protocol to use, can be tcp, udp or raw. | |
| RcvdCnt | Number of character received in internal buffer when using line mode. | |
| RcvdCount | Number of characters in receive buffer but not read yet. | |
| RcvdPtr | Internal rceive buffer pointer used for line mode. | |
| ReadCount | Total number of bytes received. | |
| ReqVerLow | Low part of winsock version to load. | |
| ReqVerHigh | High part of winsock version to load. | |
| ReuseAddr | Should the compnent try to reuse an address. | |
| SendFlags | How to send data. | |
| SocksAuthentication | Select socks server authentication mode. | |
| SocksLevel | Select socks server protocol level. | |
| SocksPassword | Password for socks server authentication. | |
| SocksPort | Port number for socks server. | |
| SocksServer | IP or hostname for socks server. | |
| SocksUsercode | Usercode for socks server authentication. | |
| State | Current state of the socket, mainly used for log or display purposes. | |
| Terminated | To be set to terminate synchronous operation prematurely. | |
| Text | Equivalent to ReceiveStr and SendStr. |
Methods
| Abort | Quick and dirty way to close the socket. | |
| Accept | Accept a new incomming connection request. | |
| CancelDnsLookup | Cancel any pending DNS lookup. | |
| Close | Close the socket gracefull. | |
| CloseDelayed | Close the socket when the current event terminate. | |
| Connect | Connect to a remote host. | |
| Create | Dynamcly create the component. | |
| DeleteBufferedData | Delete internaly buffered data. | |
| Destroy | Destroy the dynamicly created component. | |
| DnsLookup | Perform a DNS lookup of a hostname in background. See also OnDNSLookupDone. | |
| Dup | Assign a socket handle to the component. | |
| Flush | Wait until the internal buffer is flushed. Better avoid this method. | |
| GetPeerAddr | Returns the remote address where the socket has been bound to. See also PeerAddr. | |
| GetPeerName | Returns the remot hostname where the socket has been bound to. | |
| GetPeerPort | Returns the remote port where the socket has been bound to. See also PeerPort. | |
| GetSockName | Return socket binding informations. | |
| GetXAddr | Returns the local interface to where the socket has been bound to. | |
| GetXPort | Returns the local port to where the socket has been bound to. | |
| Listen | Set the socket in listening state to accept inbound connections. | |
| MessageLoop | Pump messages until WM_QUIT is received. | |
| MessagePump | Trigger OnMessagePump or call ProcessMessages. | |
| Pause | Stop delivery notification of received TCP data. | |
| PeekData | Read received data without removing it from the buffer. | |
| ProcessMessage | Similar as TApplication.ProcessMessage. | |
| ProcessMessages | Similar as TApplication.ProcessMessages. | |
| PutDataInSendBuffer | Put data in the send buffer without sending it. | |
| PutStringInSendBuffer | Put a string in the send buffer without sending it. | |
| Receive | Receive data (to be called within OnDataAvailable). | |
| ReceiveFrom | Same as Receive but returns the sender address. | |
| ReceiveStr | Receive string (to be called within OnDataAvailable). | |
| Release | Destroy the dynamicly created TWSocket in a custom message handler. | |
| Resume | Resume winsock event notifications. | |
| ReverseDnsLookup | Start an asynchronous reverse DNS lookup. | |
| Send | Send data. | |
| SendStr | Send a string. | |
| SendTo | Send data to a given remote socket (UDP only). | |
| SetLingerOption | Set the linger options defined by LingerOnOff and LingerTimeout | |
| Shutdown | Close the socket gracefully. | |
| TimerClear | Function to clear a linger timer. | |
| TimerCmp | Function to compare linger timer. | |
| TimerIsSet | Function to check a linger timer. | |
| ThreadAttach | Attach to the current thread. | |
| ThreadDetach | Detach from the current thread. | |
| WaitForClose | Wait until the socket is closed. Better avoid this method. |
Events
| OnBgException | Background exception occured. | |
| OnChangeState | State of TWSocket has changed. | |
| OnDataAvailable | Data available in internal receive buffer. | |
| OnDataSent | Internal sent buffer is completely delivered to winsock. | |
| OnDebugDisplay | To display debugging messages. | |
| OnDnsLookupDone | DNSLookup has finished. | |
| OnError | Discouraged, use exception handling instead. | |
| OnLineLimitExceeded | A message longer that LineLimit has been received. | |
| OnMessagePump | To call your own message pump. | |
| OnSendData | Winsock send buffer is empty, will be filled again by internal send buffer if still data available to send. | |
| OnSessionAvailable | Client connected to this server. | |
| OnSessionClosed | Socket has closed. | |
| OnSessionConnected | Session to host etablished. | |
| OnSocksAuthState | State of the socks authentication process. | |
| OnSocksConnected | Tells if connected to the socks server. | |
| OnSocksError | Triggered when an error occurs with socks server. |
How to
