CkoSocket

Set this property to true to request cancellation of the method currently executing on this object. It affects operations that can block or take significant time, such as network reads, writes, connection establishment, and long-running asynchronous methods. Fast, nonblocking methods may finish before the cancellation request is observed.

After an operation aborts, Chilkat automatically resets this property to false. If no operation is running, the next method call clears a previously set value before it begins.

Contains a numeric reason code when AcceptNext or the deprecated AcceptNextConnection method fails. Examine this property immediately after the failed accept operation.

Specifies the application-layer protocol name offered in the TLS ALPN extension, such as h2 or http/1.1. Leave it empty when ALPN is not required.

Limits receive throughput to approximately the specified number of bytes per second. The default value is 0, which disables receive throttling.

Limits send throughput to approximately the specified number of bytes per second. The default value is 0, which disables send throttling.

Controls the byte order used by SendCount and ReceiveCount. The default is true, which uses big-endian byte order (network byte order). Set it to false to use little-endian byte order.

Specifies the numeric local IP address to bind before initiating an outbound connection. Use this on a multihomed computer when the connection must originate from a particular network interface or local address. Leave it empty to let the operating system choose the appropriate local address.

Specifies the local TCP port to bind before initiating an outbound connection. The default value is 0, which asks the operating system to choose an available ephemeral port.

Contains a numeric reason code when Connect fails. Examine this property immediately after the failed connection attempt.

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

• A timeout property set to 0, indicating an infinite timeout.
• A hang occurring within an event callback in the application code.
• An internal bug in the Chilkat code causing the hang.

Returns the whole number of seconds elapsed since the most recent call to StartTiming. It returns 0 if timing has not been started or less than one second has elapsed.

Specifies the interval, in milliseconds, between AbortCheck callbacks during supported long-running operations. The default is 0, which disables periodic AbortCheck callbacks.

Specifies the authentication method used with an HTTP proxy. Supported values are Basic and NTLM. Leave it empty when the proxy does not require authentication.

Specifies the optional Windows domain used for NTLM authentication to an HTTP proxy. It is ignored unless HttpProxyAuthMethod is NTLM.

Set this property to true when the proxied connection will carry HTTP requests, such as when a Rest object uses this socket through UseConnection. The default is false.

An HTTP client can communicate with a proxy differently from a non-HTTP protocol. For example, plain HTTP commonly sends an absolute request URI to the proxy, whereas other protocols generally require an HTTP CONNECT tunnel.

Specifies the hostname or numeric IP address of the HTTP proxy. Leave it empty to connect directly without an HTTP proxy.

Specifies the password used to authenticate with the HTTP proxy. It is used together with HttpProxyUsername and the selected HttpProxyAuthMethod.

Specifies the TCP port of the HTTP proxy. Common values include 8080 and 3128, but the correct port is determined by the proxy configuration.

Specifies the username used to authenticate with the HTTP proxy. It is ignored when the proxy does not require authentication.

Returns true when the socket is in its last known connected state; otherwise returns false. Explicitly closing the socket updates this property immediately.

Controls the operating system SO_KEEPALIVE option for the underlying TCP socket. The default is true.

Set this property to true to record bytes sent and received in SessionLog. The default is false. Use SessionLogEncoding to choose how bytes are rendered.

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Returns true if the most recently called method on this object failed; otherwise returns false. This is especially useful for methods whose normal return type, such as a string, byte array, or integer, can otherwise make success and failure difficult to distinguish.

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

Controls the address family used by BindAndListen and BindAndListenPortRange. The default is false for an IPv4 listener. Set it to true to create an IPv6 listener.

Returns the port on which the socket is listening. This is especially useful after calling BindAndListen with port 0, which asks the operating system to select an available port.

Returns the local IP address assigned to the bound or connected socket. For an outbound connection, this is the source address selected or explicitly bound. For a listener, it is the local address on which the socket is listening.

Returns the local TCP port assigned to the bound or connected socket. When binding to port 0, use this property or ListenPort after success to discover the operating-system-selected port.

Specifies the maximum number of milliseconds a read-related operation may remain without receiving additional data. Each arrival of data represents progress and restarts the inactivity interval. The default is 0, which waits indefinitely.

This timeout applies to socket receive methods and to other operations that must read protocol data, including DNS, proxy negotiation, TLS handshakes, and SSH tunnel setup where applicable.

Specifies the maximum number of milliseconds a send-related operation may remain without making additional write progress. The default is 0, which waits indefinitely.

Returns a local IP address for the computer. On a multihomed system, this is a default or preferred local address and may not be the address used by a particular connection.

Returns the number of bytes immediately available to the socket layer without waiting. On a TLS connection, the value can include encrypted TLS record overhead and therefore does not necessarily equal the amount of application plaintext available.

Returns the number of client certificates received during the TLS handshake on an accepted server-side connection. Retrieve certificates by calling GetRcvdClientCert with indexes from 0 through NumReceivedClientCerts - 1.

Returns the number of sockets contained in this socket set. A normal Socket object becomes a socket set after one or more calls to TakeSocket.

Use SelectForReading or SelectForWriting to find ready sockets, then use SelectorReadIndex, SelectorWriteIndex, and SelectorIndex to route subsequent operations to a contained socket.

After a TLS server requests a client certificate, returns the number of acceptable certificate-authority distinguished names sent by that server. Use GetSslAcceptableClientCaDn to retrieve each DN by zero-based index.

Returns the unique identifier assigned to this socket object. The identifier is included in event callbacks so an application can associate a callback with the originating object.

Defines the numeric value that represents 100 percent in PercentDone callbacks. The default is 100. For example, a scale of 1000 permits tenths-of-a-percent values, so 453 represents 45.3 percent.

Values are clamped to the range 10 through 100000. The property affects only operations whose progress can be measured and only language bindings that expose callbacks.

Controls address-family preference when a hostname resolves to both IPv4 and IPv6 addresses. The default is false, which prefers IPv4; set it to true to prefer IPv6.

For listener sockets in current Chilkat versions, enabling IPv6 can use dual-stack behavior when supported by the operating system, allowing one listener to accept both IPv6 and IPv4 connections.

Returns the average raw receive rate, in bytes per second, since receive performance measurement began or was last reset. The measurement includes TLS or SSH framing overhead. Call ResetPerf with true to restart receive measurement.

Tracks the cumulative number of application bytes read from the underlying socket by receive operations. The application may assign 0 at any time to restart the count.

The count can be greater than the number of bytes returned by a particular method because Chilkat may read beyond a delimiter and buffer the excess for a later receive call. TLS and SSH framing overhead is not included.

Contains the value produced by the most recent successful call to ReceiveByte, ReceiveInt16, or ReceiveInt32. The signedness and byte order are determined by the arguments supplied to that receive method.

Contains a numeric reason code when a receive method fails. Examine it immediately after the failed receive operation.

Specifies the internal read size, in bytes, used by receive methods that do not request an exact byte count, such as ReceiveBytes and ReceiveString. The default is 4096.

Returns the numeric IP address of the connected peer. This is the address actually used by the established connection, which may differ from the hostname originally supplied to Connect.

Returns the TCP port of the connected peer.

When true, a TLS client connection requires successful verification of the server certificate, including certificate validity and trust-chain checks. The connection fails when verification cannot be completed. The default is false.

For a socket set, selects the contained socket to which ordinary method calls and property access are routed. Indexing is zero-based and must be within 0 through NumSocketsInSet - 1.

Selects an entry in the read-ready result set produced by SelectForReading. Set this property to a zero-based value from 0 through one less than the number returned by SelectForReading; the corresponding contained-socket index can then be obtained or selected according to the socket-set workflow.

Selects an entry in the write-ready result set produced by SelectForWriting. Set it to a zero-based value from 0 through one less than the number returned by SelectForWriting.

Returns the average raw send rate, in bytes per second, since send performance measurement began or was last reset. The measurement includes TLS or SSH framing overhead. Call ResetPerf with false to restart send measurement.

Contains a numeric reason code when a send method fails. Examine it immediately after the failed send operation.

Specifies the internal chunk size used when sending a large amount of data over a plain TCP connection. The default is 65535 bytes. TLS connections use TLS record handling rather than this setting.

Returns the accumulated send/receive session log when KeepSessionLog is true. Use SessionLogEncoding to choose an escaped or hexadecimal representation and ClearSessionLog to reset it.

Controls how bytes are rendered in SessionLog. The default is esc.

Overrides the Server Name Indication (SNI) hostname sent in the TLS ClientHello. Normally Chilkat automatically uses the domain name supplied to Connect. Set this property when connecting to a numeric IP address or alternate endpoint while the TLS server expects a particular virtual-host name.

Specifies the hostname or numeric IP address of the SOCKS proxy. It is used only when SocksVersion is 4 or 5.

Specifies the password for SOCKS5 username/password authentication. SOCKS4 does not define a password field, so this property is ignored for SOCKS4.

Specifies the TCP port of the SOCKS proxy. The default is 1080. It is used only when SocksVersion is 4 or 5.

Specifies the SOCKS proxy username. For SOCKS4 it is the user ID sent in the request; for SOCKS5 it is used when username/password authentication is negotiated.

Selects whether connections are routed through a SOCKS proxy.

Requests the operating-system receive-buffer size for the TCP socket. The default requested value is 4194304 bytes. Most applications should leave it unchanged.

Controls the SO_REUSEADDR option for a socket that will bind and listen. The default is true. Set it before BindAndListen, BindAndListenPortRange, or InitSslServer.

Requests the operating-system send-buffer size for the TCP socket. The default requested value is 262144 bytes. Most applications should leave it unchanged.

Controls whether incoming connections accepted by this listener must complete a TLS handshake. The default is false. Set it to true for a TLS server listener.

Restricts the cipher suites permitted for TLS connections. The default empty string allows all cipher suites implemented and enabled by the Chilkat build. To restrict negotiation, provide a comma-separated list of supported cipher-suite names in preference order.

The property also recognizes the policy keywords rsa1024, rsa2048, secure-renegotiation, and best-practices. Legacy filter keywords such as aes256-cbc, aes128-cbc, 3des-cbc, and rc4 remain recognized for compatibility, but explicit suites or best-practices are clearer.

Controls the TLS protocol versions permitted for secure connections. Accepted values include default, an exact version such as TLS 1.2 or TLS 1.3, and minimum-version forms such as TLS 1.2 or higher. Legacy values for older protocols are retained for compatibility.

The default value is default, which lets Chilkat negotiate an appropriate mutually supported version according to the library and platform security policy. An exact-version setting causes the connection to fail unless that exact version is negotiated.

Specifies the character encoding used by text-oriented socket methods. Examples include utf-8, windows-1252, shift_jis, and iso-8859-1. The default is ansi.

Sending methods such as SendString and SendSb encode text using this charset. String receive methods decode incoming bytes from this charset, including ReceiveString, ReceiveSb, ReceiveToCRLF, and delimiter-based string methods.

Controls the TCP_NODELAY option. The default is false, allowing the Nagle algorithm. Set it to true to send small writes with lower latency rather than waiting to coalesce them.

Returns the cipher suite negotiated for the current or most recent successful TLS connection, for example TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384. It is empty before a TLS connection has been established or after a connection attempt that did not negotiate TLS.

Specifies one or more expected SubjectPublicKeyInfo (SPKI) fingerprints for TLS public-key pinning. The TLS handshake fails unless the certificate presented by the server matches one of the listed pins.

Use the format hash_algorithm, encoding, fingerprint1, fingerprint2, .... For example:

sha256, base64, lKg1SIqyhPSK19tlPbjl8s02yChsVTDklQpkMCHvsTE=

Common choices are sha256 with base64 or hex. Other Chilkat hash and binary-encoding names are also accepted.

Returns the protocol version negotiated for the current or most recent successful TLS connection, such as TLS 1.2 or TLS 1.3. It is empty when no TLS session has been established.

Provides comma-separated compatibility or platform-specific options. The default is the empty string and should normally remain unchanged.

Stores arbitrary application text with the socket object. Chilkat does not transmit, interpret, or otherwise use this value. It is useful for associating a label, connection ID, or other application metadata with a socket.

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version of the component/library, such as "10.1.0"

Waits for and accepts the next incoming connection on a socket previously configured by BindAndListen or BindAndListenPortRange. maxWaitMs is the maximum time to wait for an incoming TCP connection; use 0 to wait indefinitely. On success, socket is populated with the accepted connection.

Returns true for success, false for failure.

Creates an asynchronous task to call the AcceptNext method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Adds a certificate-authority distinguished name to the list advertised or accepted by a TLS server when requesting a client certificate for mutual TLS. Call this method one or more times before InitSslServer.

If no CA distinguished names are added, client certificates issued by any root CA are accepted by this CA-name filter.

Returns true for success, false for failure.

Binds a TCP listener to port and places it into listening mode. Use AcceptNext to accept incoming connections after this method succeeds.

backLog is the requested operating-system queue length for connections that have completed or are completing the TCP handshake but have not yet been accepted. It is a queue hint, not a limit on the total number of clients the application can serve.

Pass 0 for port to let the operating system select an available port, then read ListenPort. Set ListenIpv6 before calling this method when an IPv6 listener is required.

Returns true for success, false for failure.

Creates an asynchronous task to call the BindAndListen method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Searches the inclusive range beginPort through endPort for an available TCP port, binds it, and begins listening. backLog is the requested operating-system pending-connection queue length.

Set ListenIpv6 before calling when an IPv6 listener is required. The method returns the selected port, or -1 when no port can be bound or another error occurs.

Creates an asynchronous task to call the BindAndListenPortRange method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Builds and returns a simple HTTP GET request for url. The method only constructs the request text; it does not connect, send the request, follow redirects, or read a response.

Returns nil on failure

Waits up to maxWaitMs for the connected socket to become writable. Use 0 to poll without waiting.

Creates an asynchronous task to call the CheckWriteable method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Clears the accumulated text returned by SessionLog. It does not change KeepSessionLog or close the connection.

Attempts to gracefully terminate and close the current TCP, TLS, or SSH channel connection. maxWaitMs limits how long the method waits for clean shutdown processing before completing.

Returns true for success, false for failure.

Creates an asynchronous task to call the Close method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Establishes a TCP connection to hostname:port. Set ssl to true to perform a TLS handshake immediately after the TCP connection succeeds; set it to false for plain TCP. The hostname may be a DNS name or a numeric IPv4 or IPv6 address.

maxWaitMs limits the TCP connection attempt itself. DNS resolution, proxy negotiation, SSH tunneling, and TLS-handshake reads and writes use the applicable MaxReadIdleMs and MaxSendIdleMs settings.

Connection options such as ClientIpAddress, ClientPort, proxy settings, PreferIpv6, TLS policy, SNI, ALPN, certificate verification, and client certificates must be configured before calling this method.

Returns true for success, false for failure.

Creates an asynchronous task to call the Connect method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Ends the TLS layer while leaving the underlying TCP connection open for subsequent unencrypted communication. This is the reverse of a STARTTLS-style upgrade.

Returns true for success, false for failure.

Creates an asynchronous task to call the ConvertFromSsl method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Upgrades an already connected plain TCP socket to TLS by performing a client-side TLS handshake over the existing connection.

Returns true for success, false for failure.

Creates an asynchronous task to call the ConvertToSsl method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Clears Chilkat's process-wide in-memory DNS cache. Subsequent hostname resolutions perform a new lookup as needed.

Resolves hostname and returns a numeric IP address. maxWaitMs is the maximum time to wait; use 0 to wait indefinitely.

Returns nil on failure

Creates an asynchronous task to call the DnsLookup method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Populates dest with another socket object that shares the same underlying TCP or TLS connection as this object. Reads and writes through either object operate on the same byte stream.

Returns true for success, false for failure.

Populates json with information about local network adapters, including IPv4 addresses, IPv6 addresses, and MAC addresses. Existing contents of the destination JSON object are replaced or populated according to the returned structure.

Returns true for success, false for failure.

Copies additional JSON details from the most recently called method into json, when that method produced such information. Many methods produce an empty result.

Copies the TLS server certificate configured by InitSslServer into cert. This method is intended for a socket acting as a TLS server and returns false when no server certificate has been configured.

Returns true for success, false for failure.

Copies the client certificate at zero-based index into cert from the TLS handshake of an accepted server-side connection. Use NumReceivedClientCerts to determine the valid index range.

Client certificates are normally supplied only when the server requests mutual TLS authentication. The application can inspect the returned certificate and close the connection when it does not satisfy authorization requirements.

Returns true for success, false for failure.

Copies the certificate presented by the remote TLS server into cert for the current client-side TLS connection. The method returns false when the socket is not connected, is not using TLS, or no server certificate is available.

Returns true for success, false for failure.

Returns the certificate-authority distinguished name at zero-based index from the list sent by a TLS server when it requests a client certificate. Valid indexes range from 0 through NumSslAcceptableClientCAs - 1.

Returns nil on failure

Configures this object to accept TLS connections using cert as the server certificate. Call it before AcceptNext. The certificate must have access to its corresponding private key.

As a convenience, this method sets the Ssl property to true when the object is not already connected.

Returns true for success, false for failure.

Loads this object with the state of the object that initiated the asynchronous operation represented by task. This is useful when the task has completed on a worker thread and the caller state must be recovered into another wrapper object.

Returns true for success, false for failure.

Loads this socket object with the result state produced by a completed asynchronous task whose result is a socket. Call it only after the task has completed successfully.

Returns true for success, false for failure.

Performs a nonblocking check for readable activity on the socket. It returns true when data or another read-ready condition is present and false when nothing is immediately available.

Creates an asynchronous task to call the PollDataAvailable method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Receives as many bytes as are currently available and appends them to binData. If no data is immediately available, the method waits up to MaxReadIdleMs for the first data.

Returns true for success, false for failure.

Creates an asynchronous task to call the ReceiveBd method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Reads exactly numBytes bytes and appends them to binData. The method continues until the requested count is satisfied or a receive failure occurs. Inactivity is controlled by MaxReadIdleMs.

Returns true for success, false for failure.

Creates an asynchronous task to call the ReceiveBdN method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Reads one byte from the connection and stores its numeric value in ReceivedInt. If bUnsigned is true, the result is in the range 0 through 255; otherwise it is interpreted as a signed byte in the range -128 through 127.

The method waits according to MaxReadIdleMs and returns false on timeout, closure, or another receive failure.

Returns true for success, false for failure.

Creates an asynchronous task to call the ReceiveByte method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Receives and returns as many bytes as are currently available. If no data is immediately available, the method waits for the first data up to MaxReadIdleMs, then returns the available bytes without waiting for a protocol-defined message length.

Returns nil on failure

Creates an asynchronous task to call the ReceiveBytes method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Performs the same receive operation as ReceiveBytes, then returns the received bytes encoded using encodingAlg. Supported Chilkat encoding names include base64, modBase64, base32, uu, qp, url, hex, q, b, url_oauth, url_rfc1738, url_rfc2396, and url_rfc3986.

Returns nil on failure

Creates an asynchronous task to call the ReceiveBytesENC method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Reads exactly numBytes bytes and returns them. The method continues reading until the requested count is satisfied or a receive failure occurs. Inactivity is limited by MaxReadIdleMs.

Returns nil on failure

Creates an asynchronous task to call the ReceiveBytesN method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Receives as many bytes as are currently available and appends them to appendFilename. If no data is immediately available, it waits up to MaxReadIdleMs for the first data.

Returns true for success, false for failure.

Creates an asynchronous task to call the ReceiveBytesToFile method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Reads a four-byte signed integer and returns it. Byte order is controlled by BigEndian, whose default is true for network byte order. The method returns -1 on failure.

Creates an asynchronous task to call the ReceiveCount method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Reads a two-byte integer and stores it in ReceivedInt. Set bigEndian to true for network byte order or false for little-endian order. Set bUnsigned to true for a value from 0 through 65535; otherwise the result ranges from -32768 through 32767.

Returns true for success, false for failure.

Creates an asynchronous task to call the ReceiveInt16 method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Reads a four-byte signed integer and stores it in ReceivedInt. Set bigEndian to true for network byte order or false for little-endian order.

Returns true for success, false for failure.

Creates an asynchronous task to call the ReceiveInt32 method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Reads exactly numBytes bytes, then returns them encoded using encodingAlg. Supported encoding names include base64, modBase64, base32, uu, qp, url, hex, q, b, url_oauth, url_rfc1738, url_rfc2396, and url_rfc3986.

The method waits until the requested byte count is received or a receive failure occurs. Inactivity is controlled by MaxReadIdleMs.

Returns nil on failure

Creates an asynchronous task to call the ReceiveNBytesENC method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Receives as many bytes as are currently available, decodes them using StringCharset, and appends the resulting text to sb. If no data is immediately available, the method waits up to MaxReadIdleMs.

Returns true for success, false for failure.

Creates an asynchronous task to call the ReceiveSb method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Receives as many bytes as are currently available and decodes them using StringCharset. If no data is immediately available, the method waits up to MaxReadIdleMs for the first data.

Returns nil on failure

Creates an asynchronous task to call the ReceiveString method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Receives and decodes text like ReceiveString, but returns at most maxByteCount input bytes. The limit is measured in bytes, not Unicode characters.

Returns nil on failure

Creates an asynchronous task to call the ReceiveStringMaxN method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Reads until the byte value lookForByte is encountered. The returned string contains the preceding bytes but excludes the matching byte. Incoming bytes are decoded according to StringCharset.

Returns nil on failure

Creates an asynchronous task to call the ReceiveStringUntilByte method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Reads and decodes text until the byte sequence CRLF (\r\n) is received. The returned string includes the terminating CRLF. Incoming bytes are decoded using StringCharset.

Returns nil on failure

Creates an asynchronous task to call the ReceiveToCRLF method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Reads bytes until lookForByte is encountered and returns all bytes up to and including that byte. The argument must identify a one-byte value from 0 through 255.

Returns nil on failure

Creates an asynchronous task to call the ReceiveUntilByte method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Reads bytes until lookForByte is encountered and appends all bytes up to and including the match to bd. The delimiter must be a one-byte value from 0 through 255.

Returns true for success, false for failure.

Creates an asynchronous task to call the ReceiveUntilByteBd method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Reads and decodes text until matchStr is found. The returned string includes the matching text. Incoming bytes are decoded according to StringCharset.

For example, a protocol header terminated by a blank line can be read using \r\n\r\n. If no additional data arrives for longer than MaxReadIdleMs, the method fails and ReceiveFailReason is typically 5.

Returns nil on failure

Creates an asynchronous task to call the ReceiveUntilMatch method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Reads and decodes text until matchStr is found, then appends the received text, including the match, to sb. Text decoding uses StringCharset, and inactivity is controlled by MaxReadIdleMs.

Returns true for success, false for failure.

Creates an asynchronous task to call the ReceiveUntilMatchSb method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Restarts one direction of transfer-rate measurement. Set rcvPerf to true to reset receive measurement for RcvBytesPerSec; set it to false to reset send measurement for SendBytesPerSec.

Waits up to timeoutMs for read-ready activity on this socket or, when the caller is a socket set, on any contained socket. Use 0 to poll.

A connected socket is read-ready when data is available or when a close/error condition can be detected. A listener is read-ready when an incoming connection is pending. Use the selector properties to choose a ready socket from a set.

Creates an asynchronous task to call the SelectForReading method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Waits up to timeoutMs for this socket, or sockets in a socket set, to become writable without blocking. Use 0 to poll.

Creates an asynchronous task to call the SelectForWriting method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends bytes from binData, beginning at offset. If numBytes is greater than 0, exactly that many bytes are sent; if it is 0, bytes are sent from offset through the end. When both values are 0, the entire BinData is sent.

The method is synchronous and uses MaxSendIdleMs as the send-progress inactivity limit.

Returns true for success, false for failure.

Creates an asynchronous task to call the SendBd method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends one byte whose value is specified by value. The value must be in the range 0 through 255. The method returns after the byte has been accepted for transmission or a send failure occurs.

Returns true for success, false for failure.

Creates an asynchronous task to call the SendByte method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends all bytes in data over the connected TCP or TLS socket. The method is synchronous and returns after the bytes have been accepted for transmission. A lack of send progress for longer than MaxSendIdleMs causes failure.

Returns true for success, false for failure.

Creates an asynchronous task to call the SendBytes method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Decodes encodedBytes using encodingAlg, then sends the resulting binary bytes. Supported Chilkat encoding names include base64, modBase64, base32, base58, uu, qp, url, hex, q, b, url_oauth, url_rfc1738, url_rfc2396, and url_rfc3986.

For example, encodedBytes="00010203040506" with encodingAlg="hex" sends seven bytes with values 00 through 06.

Creates an asynchronous task to call the SendBytesENC method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends byteCount as a four-byte signed integer. Byte order is controlled by BigEndian, whose default is true for network byte order. The peer can read the value using ReceiveCount.

Returns true for success, false for failure.

Creates an asynchronous task to call the SendCount method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends value as a two-byte integer. Set bigEndian to true for network byte order or false for little-endian order. Values outside the representable 16-bit range should not be used.

Returns true for success, false for failure.

Creates an asynchronous task to call the SendInt16 method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends value as a four-byte integer. Set bigEndian to true for network byte order or false for little-endian order.

Returns true for success, false for failure.

Creates an asynchronous task to call the SendInt32 method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Encodes the contents of sb using StringCharset and sends the resulting bytes. The method is synchronous and uses MaxSendIdleMs as the send-progress inactivity limit.

Returns true for success, false for failure.

Creates an asynchronous task to call the SendSb method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Encodes stringToSend using StringCharset and sends the resulting bytes over the connected TCP or TLS socket. The synchronous method returns after the bytes have been accepted for transmission or a send failure occurs. Send inactivity is limited by MaxSendIdleMs.

Returns true for success, false for failure.

Creates an asynchronous task to call the SendString method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends a Wake-on-LAN magic packet for macAddress to the UDP broadcast address ipBroadcastAddr and port. The MAC address is six bytes written as hexadecimal, for example 000102030405. Ports 7 and 9 are commonly used.

Call this method without first calling Connect. The target computer must have Wake-on-LAN enabled in firmware, the network adapter, and the operating system, and the network must permit the broadcast packet.

Returns true for success, false for failure.

Sends the same Wake-on-LAN magic packet as SendWakeOnLan and appends a SecureOn password. password is a hexadecimal string representing four or six bytes.

Returns true for success, false for failure.

Configures cert as the client certificate for subsequent TLS connections. The certificate must have access to its private key. Use this only when the server requests or requires client-certificate authentication.

Returns true for success, false for failure.

Loads and configures a TLS client certificate and private key from PEM data or a PEM filename supplied in pemDataOrFilename. Use pemPassword when the private key is encrypted.

Returns true for success, false for failure.

Loads and configures a TLS client certificate and private key from the PFX/P12 file pfxFilename, using pfxPassword. Use this only when the server requests or requires client-certificate authentication.

Returns true for success, false for failure.

Pauses the calling thread for approximately millisec milliseconds. This is a convenience method and does not perform network I/O or keep a connection alive.

Authenticates the SSH tunnel session as sshLogin using privateKey. Call SshOpenTunnel first. The SSH server must have the corresponding public key authorized for that account.

Returns true for success, false for failure.

Creates an asynchronous task to call the SshAuthenticatePk method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Authenticates the SSH tunnel session using sshLogin and sshPassword. Call SshOpenTunnel first and authenticate before opening forwarded channels.

Returns true for success, false for failure.

Creates an asynchronous task to call the SshAuthenticatePw method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Closes the SSH tunnel opened by SshOpenTunnel and terminates its forwarded channels. It does not close unrelated SSH objects or connections.

Returns true for success, false for failure.

Creates an asynchronous task to call the SshCloseTunnel method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Opens a new port-forwarded channel through the authenticated SSH tunnel to hostname:port and populates channel with the connected socket. If ssl is true, Chilkat establishes TLS to the destination inside the SSH tunnel. maxWaitMs limits destination connection establishment.

Multiple channels can share one authenticated SSH tunnel and can target different destination host/port pairs.

Returns true for success, false for failure.

Creates an asynchronous task to call the SshNewChannel method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Connects to the SSH server at sshHostname:sshPort and initializes an SSH tunneling session. Port 22 is conventional but not required.

After this succeeds, authenticate with SshAuthenticatePw or SshAuthenticatePk, then open forwarded destination channels with SshNewChannel. Multiple channels can share the same authenticated tunnel.

Returns true for success, false for failure.

Creates an asynchronous task to call the SshOpenTunnel method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Starts or restarts the object's convenience timer. Read ElapsedSeconds to obtain the whole number of seconds since this call.

Transfers the active connection from sock to this object. If this object already owns a connection, that connection is closed first. Unlike TakeSocket, this method does not create a socket set.

Returns true for success, false for failure.

Transfers ownership of sock into this object's internal socket set. After one or more successful calls, the caller acts as a collection of connected and/or listener sockets.

Use SelectorIndex to route normal methods and properties to a contained socket. Use SelectForReading and SelectForWriting with the selector-result properties to wait on the set.

Returns true for success, false for failure.

Requests TLS renegotiation on an established TLS connection, causing another handshake to negotiate new security parameters where the protocol and peer support it.

Returns true for success, false for failure.

Creates an asynchronous task to call the TlsRenegotiate method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Configures this socket to route subsequent Connect calls through the already connected and authenticated Ssh object. The destination host and port passed to Connect are reached by SSH port forwarding rather than by a direct TCP connection.

This is one of several SSH-tunneling models in Chilkat. Alternatives include this class's SshOpenTunnel/SshNewChannel workflow and the separate SshTunnel class for background static or dynamic forwarding.

Returns true for success, false for failure.

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the abort output argument to true. This will cause the method to terminate and return a failure status or corresponding failure value.

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

Called from the background thread when an asynchronous task completes.

Waits for and accepts the next incoming connection on a listening socket. maxWaitMs is the maximum time to wait for an incoming TCP connection; use 0 to wait indefinitely. On success, a new Socket object is returned.

Returns nil on failure

Creates an asynchronous task to call the AcceptNextConnection method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Returns another Socket object that shares the same underlying TCP or TLS connection. Reads and writes made through either object operate on the same byte stream.

Returns nil on failure

Returns the certificate configured for this object when it is acting as a TLS server. The certificate is initially supplied to InitSslServer.

Returns nil on failure

Returns the client certificate at the zero-based index received during the TLS handshake on an accepted server-side connection. Use NumReceivedClientCerts to determine the valid range.

Returns nil on failure

Returns the certificate presented by the remote TLS server for the current client-side TLS connection. It returns a null reference when the socket is not connected or the connection is not using TLS.

Returns nil on failure

Returns a JSON object containing additional details produced by the most recently called method when such details are available.

Returns nil on failure

Opens a port-forwarded channel through the authenticated SSH tunnel to hostname:port. If ssl is true, Chilkat performs TLS to the destination inside the SSH tunnel. maxWaitMs limits destination connection establishment.

Returns nil on failure

Creates an asynchronous task to call the SshOpenChannel method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure