TWSocket
Jump to navigation
Jump to search
Main page -> ICS component reference -> TWSocket
Contents
Overview
| unit | WSocket.pas | |
| inheritance |
TWSocket component is implementing the TCP protocol described in RFC 793 and and UDP protocol described in RFC 768. Both protocols are encaptulated by the IP protocol described in RFC 791. TWSocket is used in almost every other ICS component.
TWSocket component can be used as client or a server. 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 | ||
| 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 | ||
| LastError | Save the last error occured during socket operation. | |
| LineEcho | Echo all received characters back to tramitter. | |
| 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 attac. | |
| LineMode | Use LineEnd as end of line marker to trigger OnDataAvailable. | |
| LingerOnOff | ||
| LingerTimeout | ||
| 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 | ||
| MultiCastAddrStr | ||
| MultiCastIpTTL | ||
| 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 or tcp. | |
| 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 | ||
| SocksLevel | ||
| SocksPassword | ||
| 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 | ||
| CancelDnsLookup | ||
| Close | Close the socket gracefull. | |
| CloseDelayed | Close the socket gracefull in a message handler. | |
| Connect | Connect to a remote host. | |
| Create | ||
| DeleteBufferedData | ||
| Destroy | ||
| DnsLookup | Perform a DNS lookup of a hostname in background. See also OnDNSLookupDone. | |
| Dup | ||
| Flush | ||
| GetPeerAddr | Returns the remote address where the socket has been bound. See also TWSocket.PeerAddr. | |
| GetPeerName | Returns the remot hostname where the socket has been bound. | |
| GetPeerPort | Returns the remote port where the socket has been bound. See also TWSocket.PeerPort. | |
| GetSockName | ||
| GetXAddr | Returns the local interface to where the socket has been bound. | |
| GetXPort | Returns the local port to where the socket has been bound. | |
| Listen | Set the socket in listening state to accept inbound connections. | |
| MessageLoop | Pump messages until WM_QUIT is received. | |
| MessagePump | ||
| Pause | Stop delivery notification of received TCP data. | |
| PeekData | ||
| ProcessMessage | ||
| ProcessMessages | ||
| PutDataInSendBuffer | ||
| PutStringInSendBuffer | ||
| Receive | ||
| ReceiveFrom | ||
| ReceiveStr | ||
| Release | ||
| Resume | ||
| ReverseDnsLookup | ||
| Send | ||
| SendStr | ||
| SendTo | ||
| SetLingerOption | ||
| Shutdown | Close the socket gracefull. | |
| TimerClear | ||
| TimerCmp | ||
| TimerIsSet | ||
| ThreadAttach | ||
| ThreadDetach | ||
| WaitForClose | Align test |
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 | ||
| OnDnsLookupDone | DNSLookup has finished. | |
| OnError | Discouraged, use exception handling instead. | |
| OnLineLimitExceeded | Denial of service attack | |
| 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 | ||
| OnSocksConnected | ||
| OnSocksError |
How to
