CkSocket C++ Class Reference (Visual C++)
CkSocket
TCP socket component with SSL capability. Supports both asynchronous connect, accept, send, and read operations in all programming languages. The ActiveX and .NET socket components also include heartbeat, completion, and other events when blocking methods are called. DNS and reverse DNS is support in both synchronous and asynchronous modes. Supports the ability to abort all operations: connect, accept, send, receive, DNS lookups, etc. prior to completion.
Properties
bool get_AsyncAcceptFinished(void);
Set to true when an asynchronous accept operation completes. Once the asynchronous accept has finished, the success/failure is available in the AsyncAcceptSuccess boolean property. Understanding Asynchronous Sockets
void get_AsyncAcceptLog(CkString &str);
Contains the last-error information for an asynchronous accept operation.
bool get_AsyncAcceptSuccess(void);
Set to true when an asynchronous accept operation completes and is successful.
bool get_AsyncConnectFinished(void);
Set to true when an asynchronous connect operation completes.
Once the asynchronous connect has finished, the success/failure is available in the AsyncConnectSuccess boolean property.
void get_AsyncConnectLog(CkString &str);
Contains the last-error information for an asynchronous connect operation.
bool get_AsyncConnectSuccess(void);
Set to true when an asynchronous connect operation completes and is successful.
bool get_AsyncDnsFinished(void);
Set to true when an asynchronous DNS query completes. The success status is available in the AsyncDnsSuccess property.
void get_AsyncDnsLog(CkString &str);
Contains the last-error information for an asynchronous DNS query.
void get_AsyncDnsResult(CkString &str);
The IP address of the last asynchronous DNS query completed. The IP address is in nnn.nnn.nnn.nnn string form.
bool get_AsyncDnsSuccess(void);
Set to true when an asynchronous DNS query completes and is successful.
bool get_AsyncReceiveFinished(void);
Set to true when an asynchronous receive operation completes. Once the asynchronous receive has finished, the success/failure is available in the AsyncReceiveSuccess boolean property. Understanding Asynchronous Sockets
void get_AsyncReceiveLog(CkString &str);
Contains the last-error information for an asynchronous receive operation.
bool get_AsyncReceiveSuccess(void);
Set to true when an asynchronous receive operation completes and is successful.
void get_AsyncReceivedBytes(CkByteData &byteData);
Contains the data received in an asynchronous receive operation (when receiving bytes asynchronously).
void get_AsyncReceivedString(CkString &str);
Contains the string received in an asynchronous receive operation (when receiving a string asynchronously).
bool get_AsyncSendFinished(void);
Set to true when an asynchronous send operation completes. Once the asynchronous send has finished, the success/failure is available in the AsyncSendSuccess boolean property.
void get_AsyncSendLog(CkString &str);
Contains the last-error information for an asynchronous send operation.
bool get_AsyncSendSuccess(void);
Set to true when an asynchronous send operation completes and is successful.
bool get_BigEndian(void);
void put_BigEndian(bool newVal);
Applies to the SendCount and ReceiveCount methods. If BigEndian is set to true (the default) then the 4-byte count is in big endian format. Otherwise it is little endian.
void get_ClientIpAddress(CkString &str);
void put_ClientIpAddress(const char *newVal);
The IP address to use for computers with multiple network interfaces or IP addresses.
For computers with a single network interface (i.e. most computers), this property should not be set. For multihoming computers, the default IP address is automatically used if this property is not set.
The IP address is a string such as in dotted notation using numbers, not domain names, such as "165.164.55.124".
int get_ClientPort(void);
void put_ClientPort(int newVal);
Normally left at the default value of 0, in which case a unique port is assigned with a value between
1024 and 5000. This property would only be changed if it is specifically required. For example, one
customer's requirements are as follows:
"I have to connect to a Siemens PLC IP server on a technical network.
This machine expects that I connect to its server from a specific IP address using a specific port
otherwise the build in security disconnect the IP connection."
long get_ConnectFailReason(void);
If the Connect method fails, this property can be checked to determine the reason for failure.
Possible values are:
0 = success
Normal (non-SSL) sockets:
1 = empty hostname
2 = DNS lookup failed
3 = DNS timeout
4 = Aborted by application.
5 = Internal failure.
6 = Connect Timed Out
7 = Connect Rejected (or failed for some other reason)
SSL:
100 = Internal schannel error
101 = Failed to create credentials
102 = Failed to send initial message to proxy.
103 = Handshake failed.
104 = Failed to obtain remote certificate.
long get_DebugConnectDelayMs(void);
void put_DebugConnectDelayMs(long millisec);
Used to simulate a long wait when connecting to a remote server. If your application wishes to test for the handling of timeouts, you may set this value to a number of milliseconds greater than max-wait specified in the Connect method call. The default value is 0.
long get_DebugDnsDelayMs(void);
void put_DebugDnsDelayMs(long millisec);
Used to simulate a long wait when doing a DNS lookup. If your application wishes to test for the handling of timeouts, you may set this value to a number of milliseconds greater than max-wait specified in the DnsLookup method call. The default value is 0.
int get_ElapsedSeconds(void);
To be documented soon...
CkSocketProgress *get_EventCallbackObject(void) const;
void put_EventCallbackObject(CkSocketProgress *progress);
To be documented soon...
long get_HeartbeatMs(void);
void put_HeartbeatMs(long millisec);
The number of milliseconds between periodic heartbeat callbacks for blocking socket operations (connect, accept, dns query, send, receive). Set this to 0 to disable heartbeat events. The default value is 1000 (i.e. 1 heartbeat callback per second).
void get_HttpProxyAuthMethod(CkString &str);
void put_HttpProxyAuthMethod(const char *newVal);
If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy authentication method name. Valid choices are "Basic" or "NTLM".
void get_HttpProxyHostname(CkString &str);
void put_HttpProxyHostname(const char *newVal);
If an HTTP proxy is to be used, set this property to the HTTP proxy hostname or IPv4 address (in dotted decimal notation).
void get_HttpProxyPassword(CkString &str);
void put_HttpProxyPassword(const char *newVal);
If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy password.
int get_HttpProxyPort(void);
void put_HttpProxyPort(int newVal);
If an HTTP proxy is to be used, set this property to the HTTP proxy port number. (Two commonly used HTTP proxy ports are 8080 and 3128.)
void get_HttpProxyUsername(CkString &str);
void put_HttpProxyUsername(const char *newVal);
If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy login name.
bool get_IsConnected(void);
Returns true if the socket is connected. Otherwise returns false.
Note: This returns the last known state of the socket's connected state. It does not try to send any data on the socket. If a previous call resulted in the socket becoming disconnected, then false will be returned. However, if the socket was connected and the peer disconnects prior to any Chilkat Socket method calls that would send/received data (and discover the disconnection), then this will return true. In a nutshell, if this returns false, then it is known for sure that the socket is not connected, if it returns true then the last-known state of the socket was connected.
bool get_KeepSessionLog(void);
void put_KeepSessionLog(bool newVal);
Controls whether socket (or SSL) communications are logged to the SessionLog string property. To turn on session logging, set this property = true, otherwise set to false (which is the default value).
void LastErrorHtml(CkString &str);
Error information in HTML format for the last method called.
void LastErrorText(CkString &str);
Error information in plain-text format for the last method called.
void LastErrorXml(CkString &str);
Error information in XML format for the last method called.
bool get_LastMethodFailed(void);
true if the last method called on this object failed. This provides an easier (less confusing) way of determining whether a method such as ReceiveBytes succeeded or failed.
void get_LocalIpAddress(CkString &str);
The local IP address for a bound or connected socket.
int get_LocalPort(void);
The local port for a bound or connected socket.
long get_MaxReadIdleMs(void);
void put_MaxReadIdleMs(long millisec);
The maximum number of milliseconds to wait on a socket read operation while no additional data is forthcoming. To wait indefinitely, set this property to 0. The default value is 0.
long get_MaxSendIdleMs(void);
void put_MaxSendIdleMs(long millisec);
The maximum number of milliseconds to wait for the socket to become writeable on a socket write operation. To wait indefinitely, set this property to 0. The default value is 0.
void get_MyIpAddress(CkString &str);
The local IP address of the local computer. For multi-homed computers (i.e. computers with multiple IP adapters) this property returns the default IP address.
Note: This will be the internal IP address, not an external IP address. (For example, if your computer is on a LAN, it is likely to be an IP address beginning with "192.168.".
Important: Use LocalIpAddress and LocalIpPort to get the local IP/port for a bound or connected socket.
int get_NumSocketsInSet(void);
If this socket is a "socket set", then NumSocketsInSet returns the number of sockets contained in the set. A socket object can become a "socket set" by calling the TakeSocket method on one or more connected sockets. This makes it possible to select for reading on the set (i.e. wait for data to arrive from any one of multiple sockets). See the following methods and properties for more information: TakeSocket, SelectorIndex, SelectorReadIndex, SelectorWriteIndex, SelectForReading, SelectForWriting. Socket Select for Reading
long get_ObjectId(void);
Each socket object is assigned a unique object ID. This ID is passed in event callbacks to allow your application to associate the event with the socket object.
long get_ReceivePacketSize(void);
void put_ReceivePacketSize(long sizeInBytes);
The number of bytes to receive at a time (internally). This setting has an effect on methods such as ReadBytes and ReadString where the number of bytes to read is not explicitly specified. The default value is 4096.
void get_RemoteIpAddress(CkString &str);
When a socket is connected, the remote IP address of the connected peer is available in this property.
long get_RemotePort(void);
When a socket is connected, the remote port of the connected peer is available in this property.
int get_SelectorIndex(void);
void put_SelectorIndex(int newVal);
If this socket contains a collection of connected sockets (i.e. it is a "socket set") then method calls and property gets/sets are routed to the contained socket indicated by this property. Indexing begins at 0. See the TakeSocket method and SelectForReading method for more information. Socket Select for Reading
int get_SelectorReadIndex(void);
void put_SelectorReadIndex(int newVal);
When SelectForReading returns a number greater than 0 indicating that 1 or more sockets are ready for reading, this property is used to select the socket in the "ready set" for reading. See the example below: Socket Select for Reading
int get_SelectorWriteIndex(void);
void put_SelectorWriteIndex(int newVal);
To be documented soon.
long get_SendPacketSize(void);
void put_SendPacketSize(long sizeInBytes);
The number of bytes to send at a time (internally). This can also be though of as the "chunk size". If a large amount of data is to be sent, the data is sent in chunks equal to this size in bytes. The default value is 65535. (Note: This only applies to non-SSL/TLS connections. SSL and TLS have their own pre-defined packet sizes.)
void get_SessionLog(CkString &str);
Contains a log of the bytes sent and received on this socket. The KeepSessionLog property must be set to true for logging to occur.
void get_SessionLogEncoding(CkString &str);
void put_SessionLogEncoding(const char *newVal);
Controls how the data is encoded in the SessionLog. Possible values are "esc" and "hex". The default value is "esc".
When set to "hex", the bytes are encoded as a hexidecimalized string.
The "esc" encoding is a C-string like encoding, and is more compact than hex if most of the data to be logged is text. Printable us-ascii chars are unmodified. Common "C" control chars are represented as "\r", "\n", "\t", etc. Non-printable and byte values greater than 0x80 are escaped using a backslash and hex encoding: \xHH. Certain printable chars are backslashed: SPACE, double-quote, single-quote, etc.
int get_SoRcvBuf(void);
void put_SoRcvBuf(int newVal);
Sets the SO_RCVBUF socket option. In most cases this should be left unset.
int get_SoSndBuf(void);
void put_SoSndBuf(int newVal);
Sets the SO_SNDBUF socket option. In most cases this should be left unset.
void get_SocksHostname(CkString &str);
void put_SocksHostname(const char *newVal);
The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).
void get_SocksPassword(CkString &str);
void put_SocksPassword(const char *newVal);
The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.
int get_SocksPort(void);
void put_SocksPort(int newVal);
The SOCKS4/SOCKS5 proxy port. The default value is 1080.
This property only applies if a SOCKS proxy is used (if the SocksVersion property is set to 4 or 5).
void get_SocksUsername(CkString &str);
void put_SocksUsername(const char *newVal);
The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).
int get_SocksVersion(void);
void put_SocksVersion(int newVal);
SocksVersion
May be set to one of the following integer values:
0 - No SOCKS proxy is used. This is the default.
4 - Connect via a SOCKS4 proxy.
5 - Connect via a SOCKS5 proxy.
bool get_Ssl(void);
void put_Ssl(bool newVal);
Set this property to true if the socket requires an SSL connection. The default value is false.
void get_SslProtocol(CkString &str);
void put_SslProtocol(const char *newVal);
Selects the secure protocol to be used for secure (SSL) connections. Possible values are:
default
TLS 1.0
SSL 3.0
SSL 2.0
PCT 1.0
The default value is "default", which allows for the protocol to be selected dynamically at runtime based on the requirements of the server.
void get_StringCharset(CkString &str);
void put_StringCharset(const char *str);
A charset such as "utf-8", "windows-1252", "Shift_JIS", "iso-8859-1", etc. Methods for sending and receiving strings will use this charset as the encoding. Strings sent on the socket are first converted (if necessary) to this encoding. When reading, it is assumed that the bytes received are converted FROM this charset if necessary. This ONLY APPLIES TO THE SendString and ReceiveString methods. The default value is "ansi".
bool get_TcpNoDelay(void);
void put_TcpNoDelay(bool newVal);
Controls whether the TCP_NODELAY socket option is used for the underlying TCP/IP socket. The default value is false. Setting the value to true disables the Nagle algorithm and allows for better performance when small amounts of data are sent on the socket connection.
void get_UserData(CkString &str);
void put_UserData(const char *newVal);
To be documented soon...
bool get_Utf8(void) const;
void put_Utf8(bool b);
When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.
bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);
If set to true, causes LastErrorText to be more verbose. The default is false.
void get_Version(CkString &str);
The version of this component, such as "v1.0.0"
Methods
CkSocket * AcceptNextConnection(int maxWaitMs);
Blocking call to accept the next incoming connection on the socket. maxWaitMs specifies the maximum time to wait (in milliseconds). Set this to 0 to wait indefinitely. If successful, a new socket object is returned.
Important: If accepting an SSL/TLS connection, the SSL handshake is part of the connection establishment process. This involves a few back-and-forth messages between the client and server to establish algorithms and a shared key to create the secure channel. The sending and receiving of these messages are governed by the MaxReadIdleMs and MaxSendIdleMs properties. If these properties are set to 0 (and this is the default unless changed by your application), then the AcceptNextConnection can hang indefinitely during the SSL handshake process. Make sure these properties are set to appropriate values before calling this method.
void AsyncAcceptAbort();
Call this to abort an asynchronous socket connect that is running in a background thread. Asynchronous connects are initiated by calling AsyncAcceptStart.
CkSocket * AsyncAcceptSocket();
Returns the socket object for the connection accepted asynchronously in a background thread (via AsyncAcceptStart). The connected socket can only be retrieved once. A subsequent call to AsyncAcceptSocket will return a NULL reference until another connection is accepted asynchronously.
bool AsyncAcceptStart(int maxWaitMs);
Initiates a background thread to wait for and accept the next incoming TCP connection. The method will fail if an asynchronous operation is already in progress, or if the timeout expired. The timeout (in milliseconds) is passed in maxWaitMs. To wait indefinitely, set maxWaitMs to 0. Asynchronous accept operations can be aborted by calling AsyncAcceptAbort. When the async accept operation completes, the AsyncAcceptFinished property will become true. If the accept was successful, the AsyncAcceptSuccess property is set to true and the connected socket can be retrieved via the AsyncAcceptSocket method. A debug log is available in the AsyncAcceptLog property. Returns true for success, false for failure. Understanding Asynchronous Sockets
void AsyncConnectAbort();
Aborts an asynchronous connect operation running in a background thread (started by calling AsyncConnectStart).
bool AsyncConnectStart(const char * hostname, int port, bool ssl, int maxWaitMs);
Initiates a background thread to establish a TCP connection with a remote host:port. The method will fail if an asynchronous operation is already in progress, or if the timeout expired. The timeout (in milliseconds) is passed in maxWaitMs. To wait indefinitely, set maxWaitMs to 0. Set ssl = true to esablish an SSL connection. Asynchronous connect operations can be aborted by calling AsyncConnectAbort. When the async connect operation completes, the AsyncConnectFinished property will become true. If the connect was successful, the AsyncConnectSuccess property is set to true. A debug log is available in the AsyncConnectLog property. Returns true for success, false for failure.
void AsyncDnsAbort();
Aborts an asynchronous DNS lookup running in a background thread (started via the AsyncDnsStart method).
bool AsyncDnsStart(const char * hostname, int maxWaitMs);
Initiates a background thread to do a DNS query (i.e. to resolve a hostname to an IP address). The method will fail if an asynchronous operation is already in progress, or if the timeout expired. The timeout (in milliseconds) is passed in maxWaitMs. To wait indefinitely, set maxWaitMs to 0. Asynchronous DNS lookups can be aborted by calling AsyncDnsAbort. When the async DNS operation completes, the AsyncDnsFinished property will become true. If the DNS query was successful, the AsyncDnsSuccess property is set to true. A debug log is available in the AsyncDnsLog property. Finally, the DNS query result (i.e. IP address) is available in nnn.nnn.nnn.nnn string form in the AsyncDnsResult property. Returns true for success, false for failure.
void AsyncReceiveAbort();
Aborts an asynchronous receive running in a background thread (started via one of the AsyncReceive* methods).
bool AsyncReceiveBytes();
Initiates a background thread to receive bytes on an already-connected socket (ssl or non-ssl). Returns true for success, false for failure. Understanding Asynchronous Sockets
bool AsyncReceiveBytesN(unsigned long numBytes);
Initiates a background thread to receive exactly numBytes bytes on an already-connected socket (ssl or non-ssl). Returns true for success, false for failure.
bool AsyncReceiveString();
Initiates a background thread to receive text on an already-connected socket (ssl or non-ssl). The component interprets the received bytes according to the charset specified in the StringCharset property. Returns true for success, false for failure.
bool AsyncReceiveToCRLF();
Initiates a background thread to receive text on an already-connected socket (ssl or non-ssl). The asynchronous receive does not complete until a CRLF is received. The component interprets the received bytes according to the charset specified in the StringCharset property. Returns true for success, false for failure.
bool AsyncReceiveUntilMatch(const char * matchStr);
Initiates a background thread to receive text on an already-connected socket (ssl or non-ssl). The asynchronous receive does not complete until the exact string specified by matchStr is received. The component interprets the received bytes according to the charset specified in the StringCharset property. Returns true for success, false for failure.
void AsyncSendAbort();
Aborts an asynchronous send running in a background thread (started via one of the AsyncSend* methods).
bool AsyncSendBytes(const unsigned char * byteData, unsigned long numBytes);
Initiates a background thread to send bytes on an already-connected socket (ssl or non-ssl). Returns true for success, false for failure.
bool AsyncSendString(const char * stringToSend);
Initiates a background thread to send text on an already-connected socket (ssl or non-ssl). Before sending, the stringToSend is first converted (if necessary) to the charset specified by the StringCharset property. Returns true for success, false for failure.
bool BindAndListen(int port, int backLog);
Binds a TCP socket to a port and configures it to listen for incoming connections. The size of the backlog is passed in backLog. The backlog is necessary when multiple connections arrive at the same time, or close enough in time such that they cannot be serviced immediately. (A typical value to use for backLog is 5.) This method should be called once prior to receiving incoming connection requests via the AcceptNextConnection or AsyncAcceptStart methods. Returns true for success, false for failure.
void BuildHttpGetRequest(const char * url, CkString & str);
Convenience method for converting a full URL with query parameters into an HTTP GET request. The full HTTP GET request is returned as a string. Returns true for success, false for failure.
int CheckWriteable(int maxWaitMs);
Determines if the socket is writeable. Returns one of the following integer values:
1: If the socket is connected and ready for writing.
0: If a timeout occurred or if the application aborted the method during an event callback.
-1: The socket is not connected.
void ClearSessionLog();
Clears the contents of the SessionLog property.
void Close(int maxWaitMs);
Cleanly terminates and closes a TCP/IP (SSL or non-SSL) connection. The maxWaitMs applies to SSL connections because there is a handshake that occurs during secure channel shutdown.
bool Connect(const char * hostname, int port, bool ssl, int maxWaitMs);
Establishes an SSL or non-SSL connection with a remote host:port. This is a blocking call. To initiate a non-blocking (asynchronous) connection in a background thread, call AsyncConnectStart. The maximum wait time (in milliseconds) is passed in maxWaitMs. To establish an SSL connection, set ssl = true, otherwise set ssl = false.
Note: Connections do not automatically close because of inactivity. A connection will remain open indefinitely even if there is no activity. Returns true for success, false for failure. SSL/TLS Error -- SEC_E_INTERNAL_ERROR
bool ConvertFromSsl();
Closes the secure (TLS/SSL) channel leaving the socket in a connected state where data sent and received is unencrypted. Returns true for success, false for failure.
bool ConvertToSsl();
Converts a non-SSL/TLS connected socket to a secure channel using TLS/SSL. Returns true for success, false for failure.
bool DnsLookup(const char * hostname, int maxWaitMs, CkString & outStr);
Performs a DNS query to resolve a hostname to an IP address. The IP address is returned if successful. The maximum time to wait (in milliseconds) is passed in maxWaitMs. To wait indefinitely, set maxWaitMs = 0. Returns true for success, false for failure.
CkCert * GetMyCert();
Returns the digital certificate to be used for SSL connections. This method would only be called by an SSL server application. The SSL certificate is initially specified by calling InitSslServer.
CkCert * GetSslServerCert();
Returns the SSL server's digital certificate. This method would only be called by the client-side of an SSL connection. It returns the certificate of the remote SSL server for the current SSL connection. If the socket is not connected, or is not connected via SSL, then a NULL reference is returned.
bool InitSslServer(CkCert & cert);
SSL Server applications should call this method with the SSL server certificate to be used for SSL connections. Returns true for success, false for failure. SSL Server Example
bool IsUnlocked();
Returns true if the component is unlocked.
bool PollDataAvailable();
Check to see if data is available for reading on the socket. Returns true if data is waiting and false if no data is waiting to be read.
bool ReceiveBytes(CkByteData & byteData);
Receives as much data as is immediately available on a connected TCP socket. If no data is immediately available, it waits up to MaxReadIdleMs milliseconds for data to arrive.
bool ReceiveBytesN(unsigned long numBytes, CkByteData & byteData);
Reads exactly numBytes bytes from a connected SSL or non-SSL socket. This method blocks until numBytes bytes are read or the read times out. The timeout is specified by the MaxReadIdleMs property (in milliseconds).
bool ReceiveBytesToFile(const char * appendFilename);
Receives as much data as is immediately available on a connected TCP socket. If no data is immediately available, it waits up to MaxReadIdleMs milliseconds for data to arrive.
The received data is appended to the file specified by appendFilename. Returns true for success, false for failure.
int ReceiveCount();
Receives a 4-byte signed integer and returns the value received. Returns -1 on error.
bool ReceiveString(CkString & strOut);
Receives as much data as is immediately available on a TCP/IP or SSL socket. If no data is immediately available, it waits up to MaxReadIdleMs milliseconds for data to arrive. The incoming bytes are interpreted according to the StringCharset property and returned as a string. Returns true for success, false for failure. Receiving a String
bool ReceiveStringMaxN(int maxByteCount, CkString & outStr);
Same as ReceiveString, but limits the amount of data returned to a maximum of maxByteCount bytes.
(Receives as much data as is immediately available on the TCP/IP or SSL socket. If no data is immediately available, it waits up to MaxReadIdleMs milliseconds for data to arrive. The incoming bytes are interpreted according to the StringCharset property and returned as a string.) Returns true for success, false for failure.
bool ReceiveStringUntilByte(int lookForByte, CkString & outStr);
Receives bytes on a connected SSL or non-SSL socket until a specific 1-byte value is read. Returns a string containing all the bytes up to but excluding the lookForByte. Returns true for success, false for failure.
bool ReceiveToCRLF(CkString & outStr);
Reads text from the connected TCP/IP or SSL socket until a CRLF is received. Returns the text up to and including the CRLF. The incoming bytes are interpreted according to the charset specified by the StringCharset property. Returns true for success, false for failure.
bool ReceiveUntilByte(int lookForByte, CkByteData & outBytes);
Receives bytes on the TCP/IP or SSL socket until a specific 1-byte value is read. Returns all the bytes up to and including the lookForByte.
bool ReceiveUntilMatch(const char * matchStr, CkString & strOut);
Reads text from the connected TCP/IP or SSL socket until a matching string (matchStr) is received. Returns the text up to and including the matching string. As an example, to one might read the header of an HTTP request or a MIME message by reading up to the first double CRLF ("\r\n\r\n"). The incoming bytes are interpreted according to the charset specified by the StringCharset property. Returns true for success, false for failure. SSL Client Example
bool SaveLastError(const char * filename);
Saves the last error information to an XML formatted file.
int SelectForReading(int timeoutMs);
Wait for data to arrive on this socket, or any of the contained sockets if the caller is a "socket set".
(see the example at the link below for more detailed information)
Waits a maximum
of timeoutMs milliseconds. If maxWaitMs = 0, then it is effectively a poll.
Returns the number of sockets with data available for reading.
If no sockets have data available for reading, then a value of 0 is
returned. A value of -1 indicates an error condition.
Note: when the remote peer (in this case the web server) disconnects,
the socket will appear as if it has data available. A "ready" socket
is one where either data is available for reading or the socket has
become disconnected.
If the peer closed the connection, it will not be discovered until an attempt is made to read the socket. If the read fails, then the IsConnected property may be checked to see if the connection was closed. Socket Select for Reading
int SelectForWriting(int timeoutMs);
To be documented soon.
bool SendBytes(const unsigned char * byteData, unsigned long numBytes);
Sends bytes over a connected SSL or non-SSL socket. If transmission halts for more than MaxSendIdleMs milliseconds, the send is aborted. This is a blocking (synchronous) method. It returns only after the bytes have been sent. Returns true for success, false for failure.
bool SendCount(int byteCount);
Sends a 4-byte signed integer on the connection. The receiver may call ReceiveCount to receive the integer. The SendCount and ReceiveCount methods are handy for sending byte counts prior to sending data. The sender would send a count followed by the data, and the receiver would receive the count first, and then knows how many data bytes it should expect to receive. Returns true for success, false for failure.
bool SendString(const char * stringToSend);
Sends a string over a connected SSL or non-SSL (TCP/IP) socket. If transmission halts for more than MaxSendIdleMs milliseconds, the send is aborted. The string is sent in the charset encoding specified by the StringCharset property.
This is a blocking (synchronous) method. It returns after the string has been sent. Returns true for success, false for failure. SSL Client Example
void SetSslClientCert(CkCert & cert);
A client-side certificate for SSL/TLS connections is optional. It should be used only if the server demands it. This method allows the certificate to be specified using a certificate object.
bool SetSslClientCertPfx(const char * pfxFilename, const char * pfxPassword, const char * certSubjectCN);
A client-side certificate for SSL/TLS connections is optional. It should be used only if the server demands it. This method allows the certificate to be specified using a PFX file.
void SleepMs(int millisec);
Convenience method to force the calling process to sleep for a number of milliseconds.
void StartTiming();
To be documented soon...
bool TakeSocket(CkSocket & sock);
Takes ownership of the sock. sock is added to the internal set of connected sockets.
The object is now effectively a "socket set", i.e. a collection of connected sockets.
Method calls are routed to the internal sockets based on the value of the SelectorIndex property.
For example, if SelectorIndex equals 2, then a call to SendBytes is actually a call to SendBytes
on the 3rd socket in the set. (Indexing begins at 0.) Likewise, getting and setting properties
are also routed to the contained socket based on SelectorIndex. It is possible to wait on a
set of sockets for data to arrive on any of them by calling SelectForReading. See the example below: Returns true for success, false for failure. Socket Select for Reading
bool UnlockComponent(const char * code);
Unlocks the component allowing for the full functionality to be used. An arbitrary string can be passed to initiate a fully-functional 30-day trial. Returns true for success, false for failure.
const char * asyncAcceptLog();
Contains the last-error information for an asynchronous accept operation.
const char * asyncConnectLog();
Contains the last-error information for an asynchronous connect operation.
const char * asyncDnsLog();
Contains the last-error information for an asynchronous DNS query.
const char * asyncDnsResult();
The IP address of the last asynchronous DNS query completed. The IP address is in nnn.nnn.nnn.nnn string form.
const char * asyncReceiveLog();
Contains the last-error information for an asynchronous receive operation.
const char * asyncReceivedString();
Contains the string received in an asynchronous receive operation (when receiving a string asynchronously).
const char * asyncSendLog();
Contains the last-error information for an asynchronous send operation.
const char * buildHttpGetRequest(const char * url);
Convenience method for converting a full URL with query parameters into an HTTP GET request. The full HTTP GET request is returned as a string.
const char * clientIpAddress();
The IP address to use for computers with multiple network interfaces or IP addresses.
For computers with a single network interface (i.e. most computers), this property should not be set. For multihoming computers, the default IP address is automatically used if this property is not set.
The IP address is a string such as in dotted notation using numbers, not domain names, such as "165.164.55.124".
const char * dnsLookup(const char * hostname, int maxWaitMs);
Performs a DNS query to resolve a hostname to an IP address. The IP address is returned if successful. The maximum time to wait (in milliseconds) is passed in maxWaitMs. To wait indefinitely, set maxWaitMs = 0.
const char * httpProxyAuthMethod();
If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy authentication method name. Valid choices are "Basic" or "NTLM".
const char * httpProxyHostname();
If an HTTP proxy is to be used, set this property to the HTTP proxy hostname or IPv4 address (in dotted decimal notation).
const char * httpProxyPassword();
If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy password.
const char * httpProxyUsername();
If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy login name.
const char * lastErrorHtml();
Error information in HTML format for the last method called.
const char * lastErrorText();
Error information in plain-text format for the last method called.
const char * lastErrorXml();
Error information in XML format for the last method called.
const char * localIpAddress();
The local IP address for a bound or connected socket.
const char * myIpAddress();
The local IP address of the local computer. For multi-homed computers (i.e. computers with multiple IP adapters) this property returns the default IP address.
Note: This will be the internal IP address, not an external IP address. (For example, if your computer is on a LAN, it is likely to be an IP address beginning with "192.168.".
Important: Use LocalIpAddress and LocalIpPort to get the local IP/port for a bound or connected socket.
const char * receiveString();
Receives as much data as is immediately available on a TCP/IP or SSL socket. If no data is immediately available, it waits up to MaxReadIdleMs milliseconds for data to arrive. The incoming bytes are interpreted according to the StringCharset property and returned as a string. Receiving a String
const char * receiveStringMaxN(int maxByteCount);
Same as ReceiveString, but limits the amount of data returned to a maximum of maxByteCount bytes.
(Receives as much data as is immediately available on the TCP/IP or SSL socket. If no data is immediately available, it waits up to MaxReadIdleMs milliseconds for data to arrive. The incoming bytes are interpreted according to the StringCharset property and returned as a string.)
const char * receiveStringUntilByte(int lookForByte);
Receives bytes on a connected SSL or non-SSL socket until a specific 1-byte value is read. Returns a string containing all the bytes up to but excluding the lookForByte.
const char * receiveToCRLF();
Reads text from the connected TCP/IP or SSL socket until a CRLF is received. Returns the text up to and including the CRLF. The incoming bytes are interpreted according to the charset specified by the StringCharset property.
const char * receiveUntilMatch(const char * matchStr);
Reads text from the connected TCP/IP or SSL socket until a matching string (matchStr) is received. Returns the text up to and including the matching string. As an example, to one might read the header of an HTTP request or a MIME message by reading up to the first double CRLF ("\r\n\r\n"). The incoming bytes are interpreted according to the charset specified by the StringCharset property. SSL Client Example
const char * remoteIpAddress();
When a socket is connected, the remote IP address of the connected peer is available in this property.
const char * sessionLog();
Contains a log of the bytes sent and received on this socket. The KeepSessionLog property must be set to true for logging to occur.
const char * sessionLogEncoding();
Controls how the data is encoded in the SessionLog. Possible values are "esc" and "hex". The default value is "esc".
When set to "hex", the bytes are encoded as a hexidecimalized string.
The "esc" encoding is a C-string like encoding, and is more compact than hex if most of the data to be logged is text. Printable us-ascii chars are unmodified. Common "C" control chars are represented as "\r", "\n", "\t", etc. Non-printable and byte values greater than 0x80 are escaped using a backslash and hex encoding: \xHH. Certain printable chars are backslashed: SPACE, double-quote, single-quote, etc.
const char * socksHostname();
The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).
const char * socksPassword();
The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.
const char * socksUsername();
The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).
const char * sslProtocol();
Selects the secure protocol to be used for secure (SSL) connections. Possible values are:
default
TLS 1.0
SSL 3.0
SSL 2.0
PCT 1.0
The default value is "default", which allows for the protocol to be selected dynamically at runtime based on the requirements of the server.
const char * stringCharset();
A charset such as "utf-8", "windows-1252", "Shift_JIS", "iso-8859-1", etc. Methods for sending and receiving strings will use this charset as the encoding. Strings sent on the socket are first converted (if necessary) to this encoding. When reading, it is assumed that the bytes received are converted FROM this charset if necessary. This ONLY APPLIES TO THE SendString and ReceiveString methods. The default value is "ansi".
const char * userData();
To be documented soon...
const char * version();
The version of this component, such as "v1.0.0"
|