Gemini Class

Properties   Methods   Events   Config Settings   Errors  

Provides an easy way to generate content with, create embeddings from, and list models of the Google Gemini API.

Syntax

ipworksllm.Gemini

Remarks

The Gemini class provides a simple way to communicate with the Google Gemini API, the native API used by the Gemini family of models.

The class models the Gemini protocol directly rather than translating it into another vendor's shape, so every concept the API defines, such as content parts, the top level system instruction, generation configuration, and safety settings, is exposed as it actually appears on the wire.

Selecting an Endpoint

Unlike providers that name the model in the request body, the Gemini API names it in the request path, together with the operation being invoked. The ServerURL property supplies the base of that path, and a request URL is built as {ServerURL}/models/{Model}:{operation}.

By default, the class uses the official Google Gemini endpoint, https://generativelanguage.googleapis.com/v1beta. In most cases, the default endpoint is the correct choice. The ServerURL property should only be changed when connecting through a gateway or proxy that implements the Gemini API. No part of ServerURL is rewritten or normalized.

// Official Google service. The request URL becomes // https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent gemini.ServerURL = "https://generativelanguage.googleapis.com/v1beta"; gemini.APIKey = "..."; gemini.Model = "gemini-2.0-flash"; // A local or corporate gateway that exposes the same API. gemini.ServerURL = "https://llm-gateway.example.com/gemini/v1beta";

The APIKey property is sent as an x-goog-api-key header. When it is left empty, no x-goog-api-key header is sent at all, which supports gateways that inject credentials of their own.

Generating Content

A conversation is built up in the Contents collection, which holds a list of GeminiContent items. The AddContent method is a convenient way to append an item with a given Role (user or model) and Text.

The Gemini API does not accept a content item whose role is system. A system instruction is instead supplied through the SystemInstruction property, which is sent as a top level systemInstruction field alongside the conversation.

gemini.APIKey = "..."; gemini.Model = "gemini-2.0-flash"; gemini.SystemInstruction = "You are a concise assistant."; gemini.AddContent("user", "What is the capital of France?"); gemini.GenerateContent(); // The model's reply is now the last item in Contents. string reply = gemini.Contents[gemini.Contents.Count - 1].Text; Console.WriteLine(reply);

Content Parts

The Gemini API carries the content of every conversation item as an array of parts, each of which holds one member such as text, inlineData, functionCall, or functionResponse. For the common case, the Text field of a GeminiContent simply holds plain text, and the class wraps it in a single part automatically.

When richer content is needed, set Text to a raw JSON array of parts. If the value begins with [ after leading whitespace is ignored, the class sends it verbatim as the item's parts. This allows any part type supported by the API to be used without modeling each type separately.

The same rule applies in the opposite direction. When a reply consists of a single text part, the appended item holds just that text. When a reply contains multiple parts, or any part that is not text, the appended item holds the raw parts array, so that sending the conversation back to the model reproduces the model turn. For a streamed reply, all of the text that arrived is coalesced into a single leading text part, so the original ordering of text relative to interleaved parts such as functionCall is not preserved.

Note that a reply which carries no parts at all produces an appended item whose Text is empty. Such an entry should be removed, or filled in, before the conversation is sent again, because the API may reject a content item with no parts.

// Supplying an image alongside text, using the raw parts form. gemini.AddContent("user", "[{\"text\":\"What is in this picture?\"}," + " {\"inlineData\":{\"mimeType\":\"image/jpeg\"," + " \"data\":\"" + base64Image + "\"}}]"); gemini.GenerateContent();

Streaming

Setting the Stream property to True before calling GenerateContent sends the request to the streamGenerateContent operation, with the alt=sse query parameter that selects server-sent events. The ContentDelta event then fires once for each incremental fragment of text, reporting the fragment in Delta.

Once the stream completes, the fully assembled reply is appended to Contents and the FunctionCall event fires for any function call the reply contained, exactly as in the non streaming case.

gemini.Stream = true; gemini.OnContentDelta += (s, e) => { Console.Write(e.Delta); }; gemini.AddContent("user", "Write a short poem about the sea."); gemini.GenerateContent();

Function Calling

Tools give the model an opportunity to request that the calling application execute a function on its behalf. A tool is declared by first queuing its parameters with one or more calls to AddToolParam, then calling AddTool to consume the queued parameters and append a new GeminiTool item to the Tools collection. Each item is sent as one function declaration of the request's tools array.

When the model decides to call a function, its reply contains a functionCall part and the FunctionCall event fires once per part, providing the function Name and the ArgsJson arguments object the model produced.

To return the function's result, append an item with role user whose Text is a raw parts array holding a functionResponse part, then call GenerateContent again so the model can incorporate the result. The class does not build that part for the application, because the shape of a function's result is defined by the application, not by the API; the raw parts form is what makes it expressible.

gemini.AddToolParam("location", "string", "The city and state, e.g. San Francisco, CA", true); gemini.AddTool("get_weather", "Gets the current weather for a location."); bool functionCalled = false; gemini.OnFunctionCall += (s, e) => { // Execute the requested function and append its result as a // 'functionResponse' part. string result = GetWeather(e.ArgsJson); gemini.AddContent("user", "[{\"functionResponse\":{\"name\":\"" + e.Name + "\"," + " \"response\":{\"result\":\"" + result + "\"}}}]"); functionCalled = true; }; gemini.AddContent("user", "What is the weather like in Boston?"); gemini.GenerateContent(); // If a function was called, FunctionCall fired and a 'functionResponse' item // was appended above. Calling GenerateContent again lets the model produce a // final answer. if (functionCalled) gemini.GenerateContent();

Safety Settings

The SafetySettings property holds the request's safetySettings array as raw JSON text, which is sent verbatim. Each element pairs a category with a threshold. Because the value is passed through untouched, every category and threshold the API defines is reachable, and categories added by the API later require no change to the class.

gemini.SafetySettings = "[{\"category\":\"HARM_CATEGORY_HARASSMENT\"," + " \"threshold\":\"BLOCK_ONLY_HIGH\"}," + " {\"category\":\"HARM_CATEGORY_HATE_SPEECH\"," + " \"threshold\":\"BLOCK_MEDIUM_AND_ABOVE\"}]";

When this property is left empty, the safetySettings field is omitted from the request entirely and the server's own defaults apply.

Embeddings and Listing Models

The CreateEmbedding method creates an embedding vector for every item of the Embeddings collection. All of the texts are sent to {ServerURL}/models/{selected model}:batchEmbedContents in a single request, and the OutputVector field of each item is set to the vector created for that item's InputText, as JSON text containing an array of floating point numbers. Because Google publishes models dedicated to embeddings, the EmbeddingModel configuration setting may be used to select one without disturbing the Model property used for generation.

gemini.Config("EmbeddingModel=gemini-embedding-001"); gemini.Embeddings.Add(new GeminiEmbedding("What is the meaning of life?")); gemini.Embeddings.Add(new GeminiEmbedding("How much wood would a woodchuck chuck?")); gemini.CreateEmbedding(); foreach (GeminiEmbedding embedding in gemini.Embeddings) { Console.WriteLine(embedding.OutputVector); }

The ListModels method sends a request to {ServerURL}/models and fires the ModelList event once for each model reported by the server. The Gemini API reports each model under its resource name, which carries a models/ prefix; either that value or the bare identifier that follows it may be assigned to Model. Note that the endpoint returns a single page of results; the class reports the models on that first page and does not follow the page token to subsequent pages.

gemini.OnModelList += (s, e) => { Console.WriteLine(e.Name + " (" + e.DisplayName + ")"); }; gemini.ListModels();

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

APIKey The API key used to authenticate with the endpoint.
Contents The conversation history sent to and returned from the model.
Embeddings The texts to create embeddings for, and the vectors created for them.
Firewall A set of properties related to firewall access.
MaxOutputTokens The maximum number of tokens the model may generate in a reply.
Model The model used when generating content.
Proxy A set of properties related to proxy access.
SafetySettings The raw JSON array of safety settings sent with the request.
ServerURL The base URL of the Gemini API endpoint.
SSLAcceptServerCert Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert The server certificate for the last established connection.
StopSequences A comma-separated list of sequences where the model should stop generating.
Stream Whether the reply should be streamed.
SystemInstruction The system instruction sent alongside the conversation.
Temperature The sampling temperature to use for the reply.
Timeout The timeout for operations in seconds.
Tools The list of tools the model may use.
TopK The number of top choices the model samples from.
TopP The nucleus sampling cutoff to use for the reply.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

AddContent Appends an item to the Contents collection.
AddTool Appends a tool to the Tools collection.
AddToolParam Queues a parameter to be included in the next tool added via AddTool.
Config Sets or retrieves a configuration setting.
CreateEmbedding Creates an embedding vector for each item of the Embeddings collection.
DoEvents This method processes events from the internal message queue.
GenerateContent Sends the current conversation to the model and appends the reply.
Interrupt This method interrupts the current method.
ListModels Retrieves the list of models available from the endpoint.
Reset This method will reset the class.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Connected Fired immediately after a connection completes (or fails).
ConnectionStatus Fired to indicate changes in the connection state.
ContentDelta Fires once for each incremental fragment of a streamed reply.
Disconnected Fired when a connection is closed.
EndTransfer Fired when a document finishes transferring.
Error Fired when information is available about errors during data delivery.
FunctionCall Fires once for each function the model calls.
Header Fired every time a header line comes in.
Log Fired once for each log message.
ModelList Fires once for each model reported by the server.
Redirect Fired when a redirection is received from the server.
SetCookie Fired for every cookie set by the server.
SSLServerAuthentication Fired after the server presents its certificate to the client.
SSLStatus Fired when secure connection progress messages are available.
StartTransfer Fired when a document starts transferring (after the headers).
Status Fired when the HTTP status line is received from the server.
Transfer Fired while a document transfers (delivers document).

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

CompletionTokens The number of tokens generated by the last reply.
EmbeddingDimensions The number of elements each embedding vector should have.
EmbeddingModel The model used when calling CreateEmbedding.
EmbeddingTaskType The task the embedding vectors will be used for.
FinishReason The reason the model stopped generating tokens in the last reply.
PromptTokens The number of input tokens used by the last request.
RawRequest Returns the data that was sent to the server.
RawResponse Returns the data that was received from the server.
TotalTokens The total number of tokens used by the last request.
AcceptEncoding Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression This property enables HTTP compression for receiving data.
AllowHTTPFallback Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallback Whether to allow fallback from Negotiate to NTLM when authenticating.
Append Whether to append data to LocalFile.
Authorization The Authorization string to be sent to the server.
BytesTransferred Contains the number of bytes transferred in the response data.
ChunkSize Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest Set to true to compress the body of a PUT or POST request.
EncodeURL If set to True the URL will be encoded by the class.
FollowRedirects Determines what happens when the server issues a redirect.
GetOn302Redirect If set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexing HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion The version of HTTP used by the class.
IfModifiedSince A date determining the maximum age of the desired document.
KeepAlive Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN The Service Principal Name for the Kerberos Domain Controller.
LogLevel The level of detail that is logged.
MaxHeaders Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttempts Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion The negotiated HTTP version.
OtherHeaders Other headers as determined by the user (optional).
ProxyAuthorization The authorization string to be sent to the proxy server.
ProxyAuthScheme The authorization scheme to be used for the proxy.
ProxyPassword A password if authentication is to be used for the proxy.
ProxyPort Port for the proxy server (default 80).
ProxyServer Name or IP address of a proxy server (optional).
ProxyUser A user name if authentication is to be used for the proxy.
SentHeaders The full set of headers as sent by the client.
StatusCode The status code of the last response from the server.
StatusLine The first line of the last response from the server.
TransferredData The contents of the last response from the server.
TransferredDataLimit The maximum number of incoming bytes to be stored by the class.
TransferredHeaders The full set of headers as received from the server.
TransferredRequest The full request as sent by the client.
UseChunkedEncoding Enables or Disables HTTP chunked encoding for transfers.
UseIDNs Whether to encode hostnames to internationalized domain names.
UsePlatformDeflate Whether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClient Whether or not to use the platform HTTP client.
UseProxyAutoConfigURL Whether to use a Proxy auto-config file when attempting a connection.
UserAgent Information about the user agent (browser).
CloseStreamAfterTransfer If true, the class will close the upload or download stream after the transfer.
ConnectionTimeout Sets a separate timeout value for establishing a connection.
EnableHappyEyeballs Whether to use the Happy Eyeballs algorithm when connecting.
FirewallAutoDetect Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost Name or IP address of firewall (optional).
FirewallHTTPVersion The HTTP version to be used when connecting through a tunneling proxy.
FirewallListener If true, the class binds to a SOCKS firewall as a server (TCPClient only).
FirewallPassword Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort The TCP port for the FirewallHost;.
FirewallTunnelAuthScheme This configuration setting specifies the authentication mechanism to use when authenticating to a tunneling proxy.
FirewallType Determines the type of firewall to connect through.
FirewallUser A user name if authentication is to be used connecting through a firewall.
HappyEyeballsDelay The delay, in milliseconds, between connection attempts when EnableHappyEyeballs is used.
KeepAliveInterval The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger When set to True, connections are terminated gracefully.
LingerTime Time in seconds to have the connection linger.
LocalHost The name of the local host through which connections are initiated or accepted.
LocalPort The port in the local host where the class binds.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate The transfer rate limit in bytes per second.
ProxyExceptionsList A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive Determines whether or not the keep alive socket option is enabled.
TcpNoDelay Whether or not to delay when sending packets.
UseIPv6 Whether to use IPv6.
UseNTLMv2 Whether to use NTLM V2.
LogSSLPackets Controls whether SSL packets are logged when using the internal security API.
ReuseSSLSession Determines if the SSL session is reused.
SSLCACerts A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCheckCRL Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength The minimum cipher strength used for bulk encryption.
SSLClientCACerts A newline separated list of CA certificates to use during SSL client certificate validation.
SSLContextProtocol The protocol used when getting an SSLContext instance.
SSLEnabledCipherSuites The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols Used to enable/disable the supported security protocols.
SSLEnableRenegotiation Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion Returns the negotiated protocol version.
SSLServerCACerts A newline separated list of CA certificates to use during SSL server certificate validation.
SSLTrustManagerFactoryAlgorithm The algorithm to be used to create a TrustManager through TrustManagerFactory.
TLS12SignatureAlgorithms Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups The supported groups for ECC.
TLS13KeyShareGroups The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms The allowed certificate signature algorithms.
TLS13SupportedGroups The supported groups for (EC)DHE key exchange.
AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData Used to send extra data to the firewall.
InBufferSize The size in bytes of the incoming queue of the socket.
OutBufferSize The size in bytes of the outgoing queue of the socket.
BuildInfo Information about the product's build.
GUIAvailable Whether or not a message loop is available for processing events.
LicenseInfo Information about the current license.
MaskSensitiveData Whether sensitive data is masked in log messages.
UseDaemonThreads Whether threads created by the class are daemon threads.
UseInternalSecurityAPI Whether or not to use the system security libraries or an internal implementation.
UseVirtualThreads Whether threads created by the class use virtual threads instead of platform threads.

APIKey Property (Gemini Class)

The API key used to authenticate with the endpoint.

Syntax

public String getAPIKey();
public void setAPIKey(String APIKey);

Default Value

""

Remarks

This property specifies the API key used to authenticate requests. When set, it is sent as an x-goog-api-key header.

When this property is left empty, no x-goog-api-key header is sent at all. This supports gateways placed in front of the API that supply credentials of their own.

This property is not available at design time.

Contents Property (Gemini Class)

The conversation history sent to and returned from the model.

Syntax

public GeminiContentList getContents();

Remarks

This collection holds the list of GeminiContent items making up the conversation. Calling GenerateContent sends the entire collection and appends the model's reply to it.

The Gemini API accepts only the roles user and model here. A system instruction is supplied through the SystemInstruction property instead.

The AddContent method is a convenient way to append a new item to this collection without constructing a GeminiContent item directly.

This property is not available at design time.

Please refer to the GeminiContent type for a complete list of fields.

Embeddings Property (Gemini Class)

The texts to create embeddings for, and the vectors created for them.

Syntax

public GeminiEmbeddingList getEmbeddings();

Remarks

This collection holds the GeminiEmbedding items that CreateEmbedding sends to the server. Add one item for each piece of text and set its InputText; CreateEmbedding then sends all of the texts in a single request and sets the OutputVector of each item to the embedding vector created for its text.

CreateEmbedding never adds, removes, or reorders items, so the vector created for a text is always found in the same item as the text.

gemini.Embeddings.Add(new GeminiEmbedding("What is the meaning of life?")); gemini.Embeddings.Add(new GeminiEmbedding("How much wood would a woodchuck chuck?")); gemini.CreateEmbedding(); foreach (GeminiEmbedding embedding in gemini.Embeddings) { Console.WriteLine(embedding.OutputVector); }

Calling Reset clears this collection. Items of this collection are never added to Contents.

This property is not available at design time.

Please refer to the GeminiEmbedding type for a complete list of fields.

Firewall Property (Gemini Class)

A set of properties related to firewall access.

Syntax

public Firewall getFirewall();
public void setFirewall(Firewall firewall);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Please refer to the Firewall type for a complete list of fields.

MaxOutputTokens Property (Gemini Class)

The maximum number of tokens the model may generate in a reply.

Syntax

public int getMaxOutputTokens();
public void setMaxOutputTokens(int maxOutputTokens);

Default Value

0

Remarks

This property specifies an upper bound on the number of tokens the model may produce for a single reply. When the bound is reached, generation stops and the FinishReason configuration setting reports MAX_TOKENS.

When this property is left at 0 (the default), the maxOutputTokens field is omitted from the request's generationConfig object and the server's own default is used.

This property is not available at design time.

Model Property (Gemini Class)

The model used when generating content.

Syntax

public String getModel();
public void setModel(String model);

Default Value

""

Remarks

This property specifies the identifier of the model that will process the request, for example gemini-2.0-flash. This property must be set before calling GenerateContent, and before calling CreateEmbedding unless the EmbeddingModel configuration setting supplies a model of its own.

The Gemini API names the model inside the request path, as {ServerURL}/models/{Model}:{operation}. A value that already carries the models/ resource name prefix, which is the form ModelList reports, is accepted as well; the prefix is not duplicated in the request path.

The ListModels method may be used to discover the model identifiers the endpoint accepts.

This property is not available at design time.

Proxy Property (Gemini Class)

A set of properties related to proxy access.

Syntax

public Proxy getProxy();
public void setProxy(Proxy proxy);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Please refer to the Proxy type for a complete list of fields.

SafetySettings Property (Gemini Class)

The raw JSON array of safety settings sent with the request.

Syntax

public String getSafetySettings();
public void setSafetySettings(String safetySettings);

Default Value

""

Remarks

This property holds the request's safetySettings array as raw JSON text, which is sent verbatim. Each element of the array is an object with a category and a threshold, which together adjust how aggressively the model blocks a category of content.

The value is passed through untouched, so every category and threshold the API defines is reachable without the class having to model each one.

gemini.SafetySettings = "[{\"category\":\"HARM_CATEGORY_HARASSMENT\"," + " \"threshold\":\"BLOCK_ONLY_HIGH\"}]";

In the Async Edition (nsoftware.async.IPWorksLLM), the property is set the same way and the request is awaited:

gemini.SafetySettings = "[{\"category\":\"HARM_CATEGORY_HARASSMENT\"," + " \"threshold\":\"BLOCK_ONLY_HIGH\"}]"; await gemini.GenerateContent();

When this property is left empty (the default), the safetySettings field is omitted from the request entirely and the server's own defaults apply.

This property is not available at design time.

ServerURL Property (Gemini Class)

The base URL of the Gemini API endpoint.

Syntax

public String getServerURL();
public void setServerURL(String serverURL);

Default Value

"https://generativelanguage.googleapis.com/v1beta"

Remarks

This property specifies the base URL used to build request URLs. The Gemini API names the model inside the request path, so a request URL is formed as {ServerURL}/models/{Model}:{operation}, for example https://generativelanguage.googleapis.com/v1beta/models/gemini-2.0-flash:generateContent.

No part of this value is rewritten, so endpoints that include or omit a version segment (such as /v1beta) are both supported.

By default, the class uses the official Google Gemini endpoint, https://generativelanguage.googleapis.com/v1beta. In most cases, the default endpoint is the correct choice. This property should only be changed when connecting through a gateway or proxy that implements the Gemini API.

This property is not available at design time.

SSLAcceptServerCert Property (Gemini Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

public Certificate getSSLAcceptServerCert();
public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Please refer to the Certificate type for a complete list of fields.

SSLCert Property (Gemini Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

public Certificate getSSLCert();
public void setSSLCert(Certificate SSLCert);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Please refer to the Certificate type for a complete list of fields.

SSLProvider Property (Gemini Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

public int getSSLProvider();
public void setSSLProvider(int SSLProvider);

Enumerated values:
  public final static int sslpAutomatic = 0;
  public final static int sslpPlatform = 1;
  public final static int sslpInternal = 2;

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.
Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

SSLServerCert Property (Gemini Class)

The server certificate for the last established connection.

Syntax

public Certificate getSSLServerCert();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Please refer to the Certificate type for a complete list of fields.

StopSequences Property (Gemini Class)

A comma-separated list of sequences where the model should stop generating.

Syntax

public String getStopSequences();
public void setStopSequences(String stopSequences);

Default Value

""

Remarks

This property specifies up to a handful of sequences, separated by commas, at which the model will stop generating further tokens. For example, setting this to END,STOP causes generation to stop as soon as either END or STOP is produced.

When this property is left empty (the default), the stopSequences field is omitted from the request's generationConfig object.

This property is not available at design time.

Stream Property (Gemini Class)

Whether the reply should be streamed.

Syntax

public boolean isStream();
public void setStream(boolean stream);

Default Value

False

Remarks

When this property is set to True, GenerateContent sends its request to the streamGenerateContent operation and the ContentDelta event fires once for each incremental fragment of the reply as it is received.

In both cases, once the reply has been fully received it is appended to Contents as a new item with role model, and the FunctionCall event fires for each function the model called.

The default value is False.

This property is not available at design time.

SystemInstruction Property (Gemini Class)

The system instruction sent alongside the conversation.

Syntax

public String getSystemInstruction();
public void setSystemInstruction(String systemInstruction);

Default Value

""

Remarks

This property specifies the system instruction, which gives the model context and instructions that apply to the whole conversation, such as a role to adopt or a goal to pursue.

The Gemini API does not accept a content item whose role is system. The system instruction is instead a top level systemInstruction field of the request, which is what this property supplies.

When this property is left empty (the default), the systemInstruction field is omitted from the request entirely.

This property is not available at design time.

Temperature Property (Gemini Class)

The sampling temperature to use for the reply.

Syntax

public String getTemperature();
public void setTemperature(String temperature);

Default Value

""

Remarks

This property specifies the amount of randomness injected into the response. Higher values make the output more varied, while lower values make it more focused and deterministic.

When this property is left empty (the default), the temperature field is omitted from the request's generationConfig object and the server's own default is used.

This property is not available at design time.

Timeout Property (Gemini Class)

The timeout for operations in seconds.

Syntax

public int getTimeout();
public void setTimeout(int timeout);

Default Value

60

Remarks

This property specifies the timeout period in seconds for operations performed by the class.

If this is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If this is set to a positive value, the class will wait for the operation to complete before returning control. If the timeout expires before the operation completes, the class throws an exception.

Note that all timeouts are inactivity timeouts, meaning the timeout period is extended by value specified in this property when any amount of data is successfully sent or received.

This property is not available at design time.

Tools Property (Gemini Class)

The list of tools the model may use.

Syntax

public GeminiToolList getTools();

Remarks

This collection holds the list of GeminiTool items that are made available to the model when GenerateContent is called. Each item becomes one function declaration of the request's tools array. When this collection is empty, no tools field is sent in the request.

The AddToolParam and AddTool methods are a convenient way to append a new tool to this collection without constructing a GeminiTool item directly.

This property is not available at design time.

Please refer to the GeminiTool type for a complete list of fields.

TopK Property (Gemini Class)

The number of top choices the model samples from.

Syntax

public int getTopK();
public void setTopK(int topK);

Default Value

0

Remarks

This property specifies that the model should sample only from the given number of most likely tokens at each step, which removes long tail low probability responses.

When this property is left at 0 (the default), the topK field is omitted from the request's generationConfig object and the server's own default is used.

This property is not available at design time.

TopP Property (Gemini Class)

The nucleus sampling cutoff to use for the reply.

Syntax

public String getTopP();
public void setTopP(String topP);

Default Value

""

Remarks

This property specifies the cumulative probability cutoff used for nucleus sampling. The model considers only the most likely tokens whose probabilities sum to this value.

When this property is left empty (the default), the topP field is omitted from the request's generationConfig object and the server's own default is used.

This property is not available at design time.

AddContent Method (Gemini Class)

Appends an item to the Contents collection.

Syntax

public void addContent(String role, String text);

Remarks

This method appends a new item with the given Role (user or model) and Text to the Contents collection. It is a convenience equivalent to adding an item to the collection directly.

Text normally holds plain text, which is sent as a single part holding a text field. When Text instead begins with [, it is treated as a raw JSON parts array and sent verbatim, which is how parts such as inlineData or functionResponse are supplied.

A system instruction cannot be added through this method; use the SystemInstruction property instead.

AddTool Method (Gemini Class)

Appends a tool to the Tools collection.

Syntax

public void addTool(String name, String description);

Remarks

This method appends a new GeminiTool item, with the given Name and Description, to the Tools collection.

Any parameters queued by prior calls to AddToolParam are consumed and used to build the new tool's parameter schema; the parameter queue is then cleared.

Example: gemini.AddToolParam("location", "string", "The city and state, e.g. San Francisco, CA", true); gemini.AddTool("get_weather", "Gets the current weather for a location.");

In the Async Edition (nsoftware.async.IPWorksLLM), both calls are awaited:

await gemini.AddToolParam("location", "string", "The city and state, e.g. San Francisco, CA", true); await gemini.AddTool("get_weather", "Gets the current weather for a location.");

AddToolParam Method (Gemini Class)

Queues a parameter to be included in the next tool added via AddTool.

Syntax

public void addToolParam(String name, String paramType, String description, boolean required);

Remarks

This method queues a parameter to be included in the JSON Schema of the next tool appended via AddTool.

Name specifies the parameter's name.

ParamType specifies the parameter's JSON Schema type, such as string, number, boolean, or object.

Description specifies a natural language description of the parameter, which helps the model determine appropriate values for it.

Required specifies whether the model must supply a value for this parameter whenever it calls the function.

Queued parameters are consumed, and the queue is cleared, the next time AddTool is called.

Config Method (Gemini Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateEmbedding Method (Gemini Class)

Creates an embedding vector for each item of the Embeddings collection.

Syntax

public void createEmbedding();

Remarks

This method sends the InputText of every item in the Embeddings collection to {ServerURL}/models/{selected model}:batchEmbedContents in a single request, and sets the OutputVector of each item to the embedding vector the server created for its text, as JSON text containing an array of floating point numbers. Each item becomes one request of the batch, so every text receives its own vector.

The model specified by the EmbeddingModel configuration setting is used, or, when that setting is empty, the model specified by Model. Google publishes models dedicated to embeddings, such as gemini-embedding-001, which is what EmbeddingModel is normally set to. The EmbeddingDimensions and EmbeddingTaskType configuration settings, when set, are sent with every item of the batch.

gemini.Config("EmbeddingModel=gemini-embedding-001"); gemini.Embeddings.Add(new GeminiEmbedding("What is the meaning of life?")); gemini.Embeddings.Add(new GeminiEmbedding("How much wood would a woodchuck chuck?")); gemini.CreateEmbedding(); string firstVector = gemini.Embeddings[0].OutputVector;

In the Async Edition (nsoftware.async.IPWorksLLM), the same operation is awaited:

await gemini.Config("EmbeddingModel=gemini-embedding-001"); gemini.Embeddings.Add(new GeminiEmbedding("What is the meaning of life?")); gemini.Embeddings.Add(new GeminiEmbedding("How much wood would a woodchuck chuck?")); await gemini.CreateEmbedding(); string firstVector = gemini.Embeddings[0].OutputVector;

All items are sent in one request; this method never splits them over several requests. The server limits the size of that request and of each text in it, and a request beyond a limit fails with error 801, which carries the server's own explanation; spread a large set of texts over several calls in that case.

The OutputVector of every item is cleared before the request is sent, so after an error no item holds a vector. When the reply does not hold exactly one embedding for each item, this method fails with error 803. On success, the PromptTokens and TotalTokens configuration settings report the tokens the server counted; both are 0 when the reply carries no token count, which the Gemini API does not always include.

This method fails with error 802 when Embeddings is empty, when an item's InputText is empty, or when neither the EmbeddingModel configuration setting nor Model is set. Nothing is appended to Contents by this method.

DoEvents Method (Gemini Class)

This method processes events from the internal message queue.

Syntax

public void doEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

GenerateContent Method (Gemini Class)

Sends the current conversation to the model and appends the reply.

Syntax

public void generateContent();

Remarks

This method sends the entire Contents collection, together with SystemInstruction, Tools, SafetySettings, and every request property that has been set away from its default value, to {ServerURL}/models/{Model}:generateContent. Properties left at their default values are omitted from the request JSON, and the generationConfig object itself is omitted unless at least one of its properties has been set.

On success, the model's reply is appended to Contents as a new item whose role is model. When the reply is a single part of text, that text is stored directly; when the reply holds several parts, or any part that is not text, the raw parts array is stored instead so that the model turn can be reproduced exactly.

A reply the server blocked returns success with no candidate content and raises error 803; the block reason is included in the error message when the server provides one, and the full reply is available via the RawResponse configuration setting.

When Stream is set to True, the request is sent to {ServerURL}/models/{Model}:streamGenerateContent instead, with the alt=sse query parameter that selects server-sent events, and the ContentDelta event fires once for each incremental fragment of the reply as it is received. The fully assembled reply is still appended to Contents once streaming completes.

When the model calls one or more functions, the FunctionCall event fires once for each call. To continue the conversation, append an item with role user whose Text is a raw parts array holding the matching functionResponse parts, then call this method again.

The Model property must be set before calling this method.

The following example sends a short conversation and reads the reply back out of Contents.

gemini.APIKey = "..."; gemini.Model = "gemini-2.0-flash"; gemini.SystemInstruction = "You are a concise assistant."; gemini.AddContent("user", "What is the capital of France?"); gemini.GenerateContent(); string reply = gemini.Contents[gemini.Contents.Count - 1].Text;

In the Async Edition (nsoftware.async.IPWorksLLM), the same operation is awaited:

gemini.APIKey = "..."; gemini.Model = "gemini-2.0-flash"; gemini.SystemInstruction = "You are a concise assistant."; await gemini.AddContent("user", "What is the capital of France?"); await gemini.GenerateContent(); string reply = gemini.Contents[gemini.Contents.Count - 1].Text;

Interrupt Method (Gemini Class)

This method interrupts the current method.

Syntax

public void interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListModels Method (Gemini Class)

Retrieves the list of models available from the endpoint.

Syntax

public void listModels();

Remarks

This method sends a request to {ServerURL}/models. The ModelList event fires once for each model reported by the server.

This method is typically used to discover which model identifiers are valid for the Model property.

The endpoint returns a single page of results. This method reports the models on that first page and does not follow the page token to any subsequent page.

The following example prints every model the endpoint reports.

gemini.OnModelList += (s, e) => { Console.WriteLine(e.Name + " (" + e.DisplayName + ")"); }; gemini.ListModels();

In the Async Edition (nsoftware.async.IPWorksLLM), the handler returns a task and the request is awaited:

gemini.OnModelList += async (s, e) => { Console.WriteLine(e.Name + " (" + e.DisplayName + ")"); }; await gemini.ListModels();

Reset Method (Gemini Class)

This method will reset the class.

Syntax

public void reset();

Remarks

This method will reset the class's properties to their default values.

Connected Event (Gemini Class)

Fired immediately after a connection completes (or fails).

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void connected(GeminiConnectedEvent e) {}
  ...
}

public class GeminiConnectedEvent {
  public int statusCode;
  public String description;
}

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (Gemini Class)

Fired to indicate changes in the connection state.

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void connectionStatus(GeminiConnectionStatusEvent e) {}
  ...
}

public class GeminiConnectionStatusEvent {
  public String connectionEvent;
  public int statusCode;
  public String description;
}

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Firewall connection complete.
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
Remote host connection complete.
Remote host disconnected.
SSL or S/Shell connection broken.
Firewall host disconnected.
StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

ContentDelta Event (Gemini Class)

Fires once for each incremental fragment of a streamed reply.

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void contentDelta(GeminiContentDeltaEvent e) {}
  ...
}

public class GeminiContentDeltaEvent {
  public String delta;
}

Remarks

This event fires when Stream is set to True and GenerateContent is called. It fires once for each incremental fragment of text the server sends as the reply is generated.

Delta holds the fragment itself. Concatenating Delta across every occurrence of this event reconstructs the text of the reply; the assembled reply is also appended to Contents once streaming completes.

Parts of a streamed reply that are not text, such as a function call, do not fire this event; they are reported through FunctionCall once the stream completes.

The following example prints the reply as it arrives.

gemini.Stream = true; gemini.OnContentDelta += (s, e) => { Console.Write(e.Delta); }; gemini.AddContent("user", "Write a short poem about the sea."); gemini.GenerateContent();

In the Async Edition (nsoftware.async.IPWorksLLM), the handler returns a task and the request is awaited:

gemini.Stream = true; gemini.OnContentDelta += async (s, e) => { Console.Write(e.Delta); }; await gemini.AddContent("user", "Write a short poem about the sea."); await gemini.GenerateContent();

Disconnected Event (Gemini Class)

Fired when a connection is closed.

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void disconnected(GeminiDisconnectedEvent e) {}
  ...
}

public class GeminiDisconnectedEvent {
  public int statusCode;
  public String description;
}

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (Gemini Class)

Fired when a document finishes transferring.

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void endTransfer(GeminiEndTransferEvent e) {}
  ...
}

public class GeminiEndTransferEvent {
  public int direction;
}

Remarks

This event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (Gemini Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void error(GeminiErrorEvent e) {}
  ...
}

public class GeminiErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

FunctionCall Event (Gemini Class)

Fires once for each function the model calls.

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void functionCall(GeminiFunctionCallEvent e) {}
  ...
}

public class GeminiFunctionCallEvent {
  public String name;
  public String argsJson;
}

Remarks

This event fires when the model's reply contains one or more functionCall parts, once per part. It fires for both streamed and non streamed replies.

Name is the name of the function, matching the Name field of the GeminiTool item that declared it. ArgsJson holds the JSON arguments object the model produced for the call.

To continue the conversation, append an item with role user whose Text is a raw parts array holding a functionResponse part whose name is Name and whose response is the function's result, then call GenerateContent again.

The following example returns the function's result as a functionResponse part and lets the model produce a final reply.

bool functionCalled = false; gemini.OnFunctionCall += (s, e) => { gemini.AddContent("user", "[{\"functionResponse\":{\"name\":\"" + e.Name + "\"," + " \"response\":{\"result\":\"" + GetWeather(e.ArgsJson) + "\"}}}]"); functionCalled = true; }; gemini.AddContent("user", "What is the weather like in Boston?"); gemini.GenerateContent(); if (functionCalled) gemini.GenerateContent();

In the Async Edition (nsoftware.async.IPWorksLLM), the handler returns a task and each request is awaited:

bool functionCalled = false; gemini.OnFunctionCall += async (s, e) => { await gemini.AddContent("user", "[{\"functionResponse\":{\"name\":\"" + e.Name + "\"," + " \"response\":{\"result\":\"" + GetWeather(e.ArgsJson) + "\"}}}]"); functionCalled = true; }; await gemini.AddContent("user", "What is the weather like in Boston?"); await gemini.GenerateContent(); if (functionCalled) await gemini.GenerateContent();

Header Event (Gemini Class)

Fired every time a header line comes in.

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void header(GeminiHeaderEvent e) {}
  ...
}

public class GeminiHeaderEvent {
  public String field;
  public String value;
}

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (Gemini Class)

Fired once for each log message.

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void log(GeminiLogEvent e) {}
  ...
}

public class GeminiLogEvent {
  public int logLevel;
  public String message;
  public String logType;
}

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

  • "Info"
  • "RequestHeaders"
  • "ResponseHeaders"
  • "RequestBody"
  • "ResponseBody"
  • "ProxyRequest"
  • "ProxyResponse"
  • "FirewallRequest"
  • "FirewallResponse"

ModelList Event (Gemini Class)

Fires once for each model reported by the server.

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void modelList(GeminiModelListEvent e) {}
  ...
}

public class GeminiModelListEvent {
  public String name;
  public String displayName;
}

Remarks

This event fires once for each model returned in response to a call to ListModels.

Name holds the model's resource name, which the Gemini API reports with a models/ prefix, as in models/gemini-2.0-flash. Either that value or the bare identifier that follows the prefix may be assigned to Model. DisplayName holds a human readable name for the model.

Redirect Event (Gemini Class)

Fired when a redirection is received from the server.

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void redirect(GeminiRedirectEvent e) {}
  ...
}

public class GeminiRedirectEvent {
  public String location;
  public boolean accept; //read-write
}

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class throws an exception. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (Gemini Class)

Fired for every cookie set by the server.

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void setCookie(GeminiSetCookieEvent e) {}
  ...
}

public class GeminiSetCookieEvent {
  public String name;
  public String value;
  public String expires;
  public String domain;
  public String path;
  public boolean secure;
}

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (Gemini Class)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void SSLServerAuthentication(GeminiSSLServerAuthenticationEvent e) {}
  ...
}

public class GeminiSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept; //read-write
}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (Gemini Class)

Fired when secure connection progress messages are available.

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void SSLStatus(GeminiSSLStatusEvent e) {}
  ...
}

public class GeminiSSLStatusEvent {
  public String message;
}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (Gemini Class)

Fired when a document starts transferring (after the headers).

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void startTransfer(GeminiStartTransferEvent e) {}
  ...
}

public class GeminiStartTransferEvent {
  public int direction;
}

Remarks

This event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Status Event (Gemini Class)

Fired when the HTTP status line is received from the server.

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void status(GeminiStatusEvent e) {}
  ...
}

public class GeminiStatusEvent {
  public String HTTPVersion;
  public int statusCode;
  public String description;
}

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

Transfer Event (Gemini Class)

Fired while a document transfers (delivers document).

Syntax

public class DefaultGeminiEventListener implements GeminiEventListener {
  ...
  public void transfer(GeminiTransferEvent e) {}
  ...
}

public class GeminiTransferEvent {
  public int direction;
  public long bytesTransferred;
  public int percentDone;
  public byte[] text;
}

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

EffectiveDate
String (read-only)
Default Value: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
String (read-only)
Default Value: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
String (read-only)
Default Value: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
String (read-only)
Default Value: ""

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
String (read-only)
Default Value: ""

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
String (read-only)
Default Value: ""

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
String (read-only)
Default Value: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

KeyPassword
String
Default Value: ""

The password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. This field can be used to read such password-protected private keys.

NOTE: This property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey.

PrivateKey
String (read-only)
Default Value: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
boolean (read-only)
Default Value: False

Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
String (read-only)
Default Value: ""

The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
String (read-only)
Default Value: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
String (read-only)
Default Value: ""

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)
Default Value: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
String (read-only)
Default Value: ""

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
String (read-only)
Default Value: ""

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
String
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StoreB
byte[]
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StorePassword
String
Default Value: ""

If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.

StoreType
int
Default Value: 0

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This field can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

NOTE: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

NOTE: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

NOTE: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

NOTE: This store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

NOTE: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

NOTE: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, create a new Certificate object and pass cstPKCS11 as the StoreType, the full path of the PKCS#11 DLL as the Store, and the PIN as the StorePassword.

Code Example. SSH Authentication with Security Key (without CertMgr): sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

Alternatively, collect the necessary data using the CertMgr class by calling the ListStoreCertificates method after setting the corresponding properties accordingly. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate obtained with this approach, pass the previously saved security key information as the Store and set StorePassword to the PIN.

Code Example. SSH Authentication with Security Key (with CertMgr): certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
String (read-only)
Default Value: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
String (read-only)
Default Value: ""

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
String (read-only)
Default Value: ""

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
String (read-only)
Default Value: ""

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
String (read-only)
Default Value: ""

The text description of UsageFlags.

This value will be one or more of the following strings and will be separated by commas:

  • Digital Signature
  • Non-Repudiation
  • Key Encipherment
  • Data Encipherment
  • Key Agreement
  • Certificate Signing
  • CRL Signing
  • Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int (read-only)
Default Value: 0

The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:

0x80Digital Signature
0x40Non-Repudiation
0x20Key Encipherment
0x10Data Encipherment
0x08Key Agreement
0x04Certificate Signing
0x02CRL Signing
0x01Encipher Only

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
String (read-only)
Default Value: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
String
Default Value: ""

The subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma, it must be quoted.

Encoded
String
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

EncodedB
byte[]
Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

Constructors

public Certificate();

Creates a instance whose properties can be set. 

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X.509 public key. 

public Certificate(byte[] encoded);

Parses Encoded as an X.509 public key. 

public Certificate(int storeType, String store, String storePassword, String subject);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. 

public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

ConfigurationString is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the cstUser , cstMachine , cstPublicKeyFile , and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. 

public Certificate(int storeType, String store, String storePassword, byte[] encoded);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key. 

public Certificate(int storeType, byte[] store, String storePassword, String subject);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. 

public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. 

public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the class will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

The following fields are available:

Fields

AutoDetect
boolean
Default Value: False

Whether to automatically detect and use firewall system settings, if available.

Connection information will first be obtained from Java system properties, such as http.proxyHost and https.proxyHost. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified.

If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems).

FirewallType
int
Default Value: 0

The type of firewall to connect through. The applicable values are as follows:

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
String
Default Value: ""

The name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class throws an exception.

Password
String
Default Value: ""

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.

Port
int
Default Value: 0

The Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.

NOTE: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
String
Default Value: ""

A username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the class throws an exception.

Constructors

public Firewall();

GeminiContent Type

A single item of a conversation.

Remarks

This type represents a single item making up part of a conversation held in the Contents collection.

The following fields are available:

Fields

Role
String
Default Value: ""

The role of the item's author.

This field identifies the role of the item's author. The Gemini API accepts only user and model here; a system instruction is supplied through the SystemInstruction property instead.

Text
String
Default Value: ""

The text of the item.

This field normally holds the plain text of the item, which is sent as a single part holding a text field.

When the value instead begins with [, it is treated as a raw JSON parts array and sent verbatim, which is how parts such as inlineData, fileData, or functionResponse are supplied.

The same distinction applies to a reply appended by GenerateContent. A reply consisting of one text part is stored as plain text, while a reply holding several parts, or any part that is not text, is stored as the raw parts array.

Constructors

public GeminiContent();

GeminiEmbedding Type

A piece of text and the embedding vector created for it.

Remarks

This type represents one item of the Embeddings collection. Set InputText to the text to embed before calling CreateEmbedding. When that method returns, OutputVector holds the embedding vector the server created for the text.

The following fields are available:

Fields

InputText
String
Default Value: ""

The text to create an embedding for.

This field holds the text that CreateEmbedding sends to the server for this item. It must not be empty; otherwise CreateEmbedding fails with error 802 before anything is sent.

OutputVector
String (read-only)
Default Value: ""

The embedding vector created for the text, as a JSON array.

This field holds the embedding vector the server created for InputText, as JSON text containing an array of floating point numbers, for example [0.0023064255,-0.009327292,0.015797347]. Each number is reported exactly as the server wrote it; only the whitespace between the numbers is removed. The number of elements depends on the model, and on the EmbeddingDimensions configuration setting when that setting is set.

This field is empty until CreateEmbedding succeeds. CreateEmbedding clears it in every item before its request is sent, so a failed call never leaves a vector from an earlier call next to new text.

Constructors

public GeminiEmbedding();

public GeminiEmbedding(String inputText);

GeminiTool Type

A tool the model may use.

Remarks

This type represents a single tool made available to the model via the Tools collection. Each item becomes one function declaration of the request's tools array.

The following fields are available:

Fields

Description
String
Default Value: ""

A description of what the tool does.

This field holds a natural language description of what the tool does and when it should be used. A thorough description materially improves the model's ability to choose the tool appropriately.

Name
String
Default Value: ""

The unique name associated with the tool.

This field identifies the unique name associated with the tool. The model uses this name when it calls the tool, and it is reported as the Name parameter of the FunctionCall event.

ParametersSchema
String
Default Value: ""

The raw JSON Schema describing the tool's parameters.

This field holds the raw JSON Schema object describing the parameters the tool expects, as built from calls to AddToolParam or as set directly. It is sent as the parameters member of the tool's function declaration.

When left empty, a schema equivalent to {"type": "object"} (no parameters) is used.

Constructors

public GeminiTool();

Proxy Type

The proxy the class will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

The following fields are available:

Fields

AuthScheme
int
Default Value: 0

The type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the class will attempt basic authentication.

If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If AuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this field will clear the values of User and Password.

AutoDetect
boolean
Default Value: False

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Note: This setting is applicable only in Windows.

Password
String
Default Value: ""

A password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
int
Default Value: 80

The Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.

Server
String
Default Value: ""

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the Server field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.

SSL
int
Default Value: 0

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

psAutomatic (0)Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option.
psAlways (1)The connection is always SSL-enabled.
psNever (2)The connection is not SSL-enabled.
psTunnel (3)The connection is made through a tunneling (HTTP) proxy.

User
String
Default Value: ""

A username if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

public Proxy();

public Proxy(String server, int port);

public Proxy(String server, int port, String user, String password);

Config Settings (Gemini Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

Gemini Config Settings

CompletionTokens:   The number of tokens generated by the last reply.

This setting may be queried after calling GenerateContent to determine the number of tokens the provider counted toward the generated portion of the last reply. This setting is read only.

EmbeddingDimensions:   The number of elements each embedding vector should have.

This setting asks the server to shorten every embedding vector created by CreateEmbedding to the given number of elements, which saves storage and speeds up comparisons at a small cost in accuracy. The value is sent as the outputDimensionality field of every request in the batch. Google recommends 768, 1536, or 3072.

Google documents that gemini-embedding-001 returns normalized vectors only at its full size of 3072 elements; a shortened vector from that model must be normalized before it is compared by dot product. Cosine similarity, which divides by the lengths of both vectors, needs no normalization.

When this setting is 0 (the default), the field is omitted and the model's full vector is returned.

EmbeddingModel:   The model used when calling CreateEmbedding.

This setting specifies the model identifier used when CreateEmbedding is called, for example gemini-embedding-001. When this setting is left empty (the default), the model specified by Model is used instead.

EmbeddingTaskType:   The task the embedding vectors will be used for.

This setting tells the model what the embedding vectors created by CreateEmbedding will be used for, so that it can create vectors suited to that task. The value is sent verbatim as the taskType field of every request in the batch. Google documents the following values:

SEMANTIC_SIMILARITYTo assess how similar texts are.
CLASSIFICATIONTo classify texts according to preset labels.
CLUSTERINGTo cluster texts based on their similarities.
RETRIEVAL_DOCUMENTFor documents that a search will retrieve.
RETRIEVAL_QUERYFor search queries.
CODE_RETRIEVAL_QUERYFor natural language queries that retrieve code blocks.
QUESTION_ANSWERINGFor questions, to find the documents that answer them.
FACT_VERIFICATIONFor statements, to find the documents that support or refute them.

For a search, embed the documents with RETRIEVAL_DOCUMENT and the query with RETRIEVAL_QUERY. Not every model accepts this field: Google documents it for gemini-embedding-001, and states that gemini-embedding-2 does not support it.

When this setting is left empty (the default), the field is omitted.

FinishReason:   The reason the model stopped generating tokens in the last reply.

This setting may be queried after calling GenerateContent to determine why the model stopped generating tokens, for example STOP, MAX_TOKENS, SAFETY, or RECITATION. This setting is read only.

PromptTokens:   The number of input tokens used by the last request.

This setting may be queried after calling GenerateContent or CreateEmbedding to determine the number of tokens the provider counted toward the prompt (input) portion of the last request. This setting is read only.

RawRequest:   Returns the data that was sent to the server.

This setting may be queried after calling any method that sends data to the server to obtain the raw request data that was transmitted. Such data may be useful for troubleshooting purposes.

RawResponse:   Returns the data that was received from the server.

This setting may be queried after calling any method that sends data to the server to obtain the raw response data that was received. Such data may be useful for troubleshooting purposes.

TotalTokens:   The total number of tokens used by the last request.

This setting may be queried after calling GenerateContent or CreateEmbedding to determine the total number of tokens the provider counted for the last request. The Gemini API reports no total for embeddings, so after CreateEmbedding this setting holds the same value as PromptTokens. This setting is read only.

HTTP Config Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. NOTE: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class throws an exception if the server does not support HTTP/2.

The default value is True.

AllowNTLMFallback:   Whether to allow fallback from Negotiate to NTLM when authenticating.

This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the class will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. NOTE: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False.

Append:   Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization:   The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred:   Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the class processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL:   If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects:   Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class throws an exception.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class throws an exception instead.

Following are the valid options:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

GetOn302Redirect:   If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing:   HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the class not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion:   The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

  • "1.0"
  • "1.1" (default)
  • "2.0"
  • "3.0"

When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/2 is supported on all platforms. The class will use the internal security implementation in all cases when connecting.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince:   A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the class throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive:   Determines whether the HTTP connection is closed after completion of the request.

If true, the class will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel:   The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxHeaders:   Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired.

This configuration setting should be set when the TransferredHeaders collection is to be populated when a Header event has been fired. This value represents the number of headers that are to be saved in the collection.

To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

MaxHTTPCookies:   Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.

This configuration setting should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection.

To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

MaxRedirectAttempts:   Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders:   Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization:   The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classes that do not directly expose Proxy properties.

ProxyPassword:   A password if authentication is to be used for the proxy.

This configuration setting is provided for use by classes that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This configuration setting is provided for use by classes that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classes that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classes that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode:   The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine:   The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders:   The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest:   The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified.

UsePlatformDeflate:   Whether to use the platform implementation to decompress compressed responses.

This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to True (default), the platform implementation is used. If set to False, an internal implementation is used.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the class will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

UseProxyAutoConfigURL:   Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.

When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent:   Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Class - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

CloseStreamAfterTransfer:   If true, the class will close the upload or download stream after the transfer.

This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True.

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

EnableHappyEyeballs:   Whether to use the Happy Eyeballs algorithm when connecting.

When enabled, the class uses the Happy Eyeballs (RFC 8305) algorithm when connecting. Instead of connecting to a single address, all of the addresses returned when resolving the RemoteHost are collected and sorted so that IPv4 and IPv6 addresses alternate. Connection attempts are then started, in turn, to each address; the delay between starting successive attempts is controlled by the HappyEyeballsDelay setting. The first address to connect successfully is used and any other connection attempts still in progress are aborted.

This setting is a convenient alternative to setting UseIPv6 to 3.

Note that when this setting is enabled, LocalPort must be 0 and LocalHost must be empty or "localhost"; the class throws an exception if either is set to another value.

The default value is false.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classes that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

FirewallHTTPVersion:   The HTTP version to be used when connecting through a tunneling proxy.

When FirewallType is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

FirewallListener:   If true, the class binds to a SOCKS firewall as a server (TCPClient only).

This entry is for TCPClient only and does not work for other classes that descend from TCPClient.

If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties.

FirewallTunnelAuthScheme:   This configuration setting specifies the authentication mechanism to use when authenticating to a tunneling proxy.

Possible values are as follows:

1AuthDigest
3AuthNone
4AuthNTLM
5AuthNegotiate
FirewallType:   Determines the type of firewall to connect through.

Possible values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class throws an exception.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

HappyEyeballsDelay:   The delay, in milliseconds, between connection attempts when EnableHappyEyeballs is used.

When EnableHappyEyeballs is enabled (or UseIPv6 is set to 3), the class may attempt to connect to several candidate addresses concurrently. This setting controls the delay, in milliseconds, before a connection attempt is started to the next candidate address, giving the previous attempt a chance to succeed first.

The default value is 250.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds.

This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.example.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:

0 IPv4 only
1 IPv6 only
2 IPv6 with IPv4 fallback
3 Happy Eyeballs (the class will attempt to connect to IPv4 and IPv6 addresses concurrently and use whichever connects first)

Setting this configuration setting to 3 is equivalent to enabling the EnableHappyEyeballs setting. See EnableHappyEyeballs and HappyEyeballsDelay for more details.

UseNTLMv2:   Whether to use NTLM V2.

When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACerts:   A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: 

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class throws an exception.

When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCheckOCSP:   Whether to use OCSP to check the status of the server certificate.

This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class throws an exception.

When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.

SSLClientCACerts:   A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server classes (e.g., TCPServer) see SSLServerCACerts for client classes (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: 

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLContextProtocol:   The protocol used when getting an SSLContext instance.

Possible values are SSL, SSLv2, SSLv3, TLS, and TLSv1. Use this configuration setting only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

NOTE: This value must be set after SSLProvider is set.

Example values: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA"); obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA"); Possible values when SSLProvider is set to Platform include the following:

  • SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
  • SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • SSL_RSA_WITH_RC4_128_SHA
  • SSL_RSA_WITH_DES_CBC_SHA
  • SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
  • SSL_DH_anon_WITH_DES_CBC_SHA
  • SSL_RSA_EXPORT_WITH_RC4_40_MD5
  • SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
  • SSL_DH_anon_EXPORT_WITH_RC4_40_MD5
  • SSL_DHE_DSS_WITH_DES_CBC_SHA
  • SSL_RSA_WITH_NULL_MD5
  • SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
  • SSL_DHE_RSA_WITH_DES_CBC_SHA
  • SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA
  • SSL_RSA_WITH_NULL_SHA
  • SSL_DH_anon_WITH_RC4_128_MD5
  • SSL_RSA_WITH_RC4_128_MD5
  • SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • SSL_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_NULL_SHA
  • TLS_DH_anon_WITH_AES_128_CBC_SHA256 (Not Recommended)
  • TLS_ECDH_anon_WITH_RC4_128_SHA
  • TLS_DH_anon_WITH_AES_128_CBC_SHA (Not Recommended)
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_KRB5_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_KRB5_EXPORT_WITH_RC4_40_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDH_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDH_anon_WITH_NULL_SHA
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_NULL_SHA256
  • TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA
  • TLS_KRB5_WITH_RC4_128_MD5
  • TLS_ECDHE_ECDSA_WITH_NULL_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_RC4_128_SHA
  • TLS_EMPTY_RENEGOTIATION_INFO_SCSV
  • TLS_KRB5_WITH_3DES_EDE_CBC_MD5
  • TLS_KRB5_WITH_RC4_128_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_NULL_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_KRB5_WITH_DES_CBC_MD5
  • TLS_KRB5_EXPORT_WITH_RC4_40_MD5
  • TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5
  • TLS_ECDH_anon_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_KRB5_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_NULL_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA

Possible values when SSLProvider is set to Internal include the following:

  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client classes, and 3072 for server classes. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default - Client and Server)
TLS1.1768 (Hex 300) (Default - Client)
TLS1 192 (Hex C0) (Default - Client)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

Note that only TLS 1.2 is enabled for server classes that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client classes enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the SSLProvider is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

If set to 1 (Platform provider), please be aware of the following notes:

  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

In the Java edition, the class checks at runtime whether the security provider backing that default context supports the TLSv1.3 protocol.

The built-in SunJSSE provider supports TLS 1.3 starting with Java 11. On earlier Java versions, TLS 1.3 support depends on installing a third-party provider that supports it, and registering that provider ahead of the defaults.

If SSLProvider is set to Platform and the default security provider does not support TLSv1.3, an exception is thrown.

Example values: Security.insertProviderAt(new org.conscrypt.OpenSSLProvider(), 1); obj.setSSLProvider(HTTP.sslpPlatform); obj.config("SSLEnabledProtocols=12288");

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server classes (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server classes (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server classes (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server classes (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server classes (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server classes (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLServerCACerts:   A newline separated list of CA certificates to use during SSL server certificate validation.

This configuration setting is only used by client classes (e.g., TCPClient) see SSLClientCACerts for server classes (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: 

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLTrustManagerFactoryAlgorithm:   The algorithm to be used to create a TrustManager through TrustManagerFactory.

Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call.

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class throws an exception.

The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)
  • "mlkem_512" (default)
  • "mlkem_768" (default)
  • "mlkem_1024" (default)
  • "x25519_mlkem_768" (default)
  • "secp256r1_mlkem_768" (default)

Post-quantum algorithms (mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768) in our classes rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

  • Windows Server 2025
  • Windows 11 24H2
  • Windows 11 25H2

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitiveData:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

UseDaemonThreads:   Whether threads created by the class are daemon threads.

If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to false by default on all platforms.

UseVirtualThreads:   Whether threads created by the class use virtual threads instead of platform threads.

If set to true, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is false.

Trappable Errors (Gemini Class)

Gemini Errors

801   The server returned an error. The error message text from the response is included when available.
802   A required property has not been set. Set the Model property before calling this method, and add at least one item with a non-empty InputText to the Embeddings collection before calling CreateEmbedding.
803   The server response could not be parsed, or did not contain the expected content.

HTTP Errors

118   Firewall error. The error description contains the detailed message.
143   Busy executing current method.
151   HTTP protocol error. The error message has the server response.
152   No server specified in URL.
153   Specified URLScheme is invalid.
155   Range operation is not supported by server.
156   Invalid cookie index (out of range).
301   Interrupted.
302   Cannot open AttachedFile.

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
303   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on nonsocket.
10039   [10039] Destination address required.
10040   [10040] Message is too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol is not supported.
10044   [10044] Socket type is not supported.
10045   [10045] Operation is not supported on socket.
10046   [10046] Protocol family is not supported.
10047   [10047] Address family is not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Cannot assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Cannot send after socket shutdown.
10059   [10059] Too many references, cannot splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name is too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory is not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock is not loaded yet.
11001   [11001] Host not found.
11002   [11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).