IPWorks 2022 macOS Edition
Version 22.0 [Build 8369]

GRPC Module

Properties   Methods   Events   Config Settings   Errors  

The GRPC module is designed to send and receive messages over gRPC. The module can be used to both create messages to send as well as read incoming messages.

Syntax

IPWorks.Grpc

Remarks

The GRPC class is designed to send and receive messages over gRPC and operates using an HTTP/2 client. This component can be used to construct a message with fields as defined in the .proto configuration file. The created message can be sent through gRPC using the Post method. If the request requires authorization, you can set the Authorization property to the authorization header. Also, the component can be used to read an incoming message from the server.

The GRPC class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

Reading a Message

The GRPC class can be used to read an incoming message. To read an incoming message, listen to the MessageIn event. The MessageIn event will fire for each message response from the server. For each message response, the MessageData property will get populated with the raw message response from the server. The component can be used to read the response in a structured way.

There are two ways of reading an incoming message. The message can be navigated using the XPath property, or by sequentially reading the values in the message. By providing multiple ways to read a message, you can choose which best suits your needs.

XPath

XPath provides a simple way to navigate the fields within the received message using a subset of the XML XPath specification. The XPath property may be set to navigate to a specific field within the message structure. The HasXPath method may be used to determine whether or not an XPath exists before setting navigating to the location. The TryXPath method will attempt to navigate to the specified path and return True or False depending on the result.

XPath may be set to a series of one or more field accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location. After setting the XPath property, use any of the following methods to read data or information about the field at the selected path:

The following are possible values for a field accessor:

field_number The integer number of the field: for instance, /2 or /11
field_number[i] The i-th occurrence of the field specified by the field_number: for instance, /2[1] or /11[3]
[index] The field at the position specified by index: for instance, /[2] would select the second field, regardless of the field number
. The current location
.. The parent of the current location

Nested Messages

When a field of a message is itself another message, the fields of the submessage may be accessed by constructing an XPath to point to the submessage field. For example, /5/4 would move to field number 5 in the top-level message (which is itself a message), and then would move to field number 4 of the submessage.

Packed Repeated Fields

The following example shows the syntax to access values within packed repeated fields. The type of value within the packed repeated field must be known ahead of time. The XCount property can be used to obtain the number of values within the packed repeated field.

/10#v Select field number 10, which is a packed repeated field of type variant
/11#i Select field number 11, which is a packed repeated field of type fixed32
/12#l Select field number 12, which is a packed repeated field of type fixed64
/10#v[2] Select the 2nd value of field number 10, which is a packed repeated field of type variant
/11#v[2] Select the 2nd value of field number 11, which is a packed repeated field of type fixed32
/12#v[2] Select the 2nd value of field number 12, which is a packed repeated field of type fixed64

Example. Iterate through all values within a packed repeated field: gRPC.XPath = "/10#v"; int count = gRPC.XCount; for(int i=0;i<count;i++) { gRPC.XPath = "/10#v[ " + i.ToString() + "]"; Console.WriteLine(Int32.Parse(gRPC.ReadInt32())); }

Sequential Reads

An alternative to using the XPath property is sequentially reading each field within the message. This is done by making use of the MessageIn event and the Read* methods to read the message fields sequentially.

To read a message sequentially, first call BeginReadMessage. Next, call ReadFieldNumber to get the next field number. The component will move automatically to the next field number to read. Then call the appropriate method from the following list to read the field value:

Example 1. Read message: // Begins reading a new message grpc.BeginReadMessage(); // Gets the field number for the current field to read String CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the string value of field with field number 1 String stringField = grpc.ReadString(); // Gets the next field number CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the int32 value of the field int Int32Field = grpc.ReadInt32(); // Ends reading a message grpc.EndReadMessage();

If the field you want to read is a packed repeated field, then before calling any of the listed methods, call BeginReadPacked. BeginReadPacked returns the count of the repeated values. Call the ReadInt32 method to sequentially read each packed value. When done reading the packed repeated values, call EndReadPacked.

Example 2. Read message example, including a packed repeated field:

// Begins reading a new message grpc.BeginReadMessage(); // Gets the field number for the current field to read String CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the count of the packed repeated field int count = grpc.BeginReadPacked(0); int[] theValues = new int[count]; for(int i=0 ;i < count; i++) { // Get the values and store them in the theValues array theValues[i] = grpc.ReadInt32(); } // Ends reading a packed repeated field grpc.EndReadPacked(); // Ends reading a message grpc.EndReadMessage();

As a last step, call EndReadMessage.

Writing a Message

The GRPC class can be used to construct a new message. The message can be written sequentially, one field at a time. The message then can be sent through gRPC by using the Post method.

To write a message, first call BeginWriteMessage. Next, call WriteFieldNumber and pass the field number to write. Then call the appropriate method from the following list to write the field value.

  • WriteString
  • WriteInt32
  • WriteInt64
  • WriteFloat
  • WriteFixed32
  • WriteFixed64
  • WriteDouble
  • WriteBytes
  • WriteBool

Example 1. Write message: // Begins writing a new message grpc.BeginWriteMessage(); // Specifies the field number for the current field to write grpc.WriteFieldNumber(1); // Specifies the value of field with field number 1 grpc.WriteString("test"); grpc.WriteFieldNumber(2); grpc.WriteInt32(2); // Ends writing a message grpc.EndWriteMessage();

Example 2. Write message, including a packed repeated field: int[] RepeatedVarInt = new int[] { 3, 270, 86942 }; // Begins writing a new message grpc.BeginWriteMessage(); //Specifies the field number for the current field to write grpc.WriteFieldNumber(1); // Begins writing a packed repeated field grpc.BeginWritePacked(); for(int i=0 ;i < RepeatedVarInt.Length; i++) { // Write each packed value grpc.WriteInt32(RepeatedVarInt[i]); } // Ends writing a packed repeated field grpc.EndWritePacked(); // Ends writing a new message grpc.EndWriteMessage();

As a last step, call EndWriteMessage.

Property List


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

AuthorizationThis is the authorization string to be sent to the server.
ConnectedThis property shows whether the module is connected.
FirewallA set of properties related to firewall access.
FollowRedirectsThis property determines what happens when the server issues a redirect.
GRPCTimeoutThe gRPC timeout.
IdleThe current status of the module.
MessageDataThis property contains the message in a raw format.
OtherHeadersThis property includes other headers as determined by the user (optional).
ParsedHeadersThis property includes a collection of headers returned from the last request.
ProxyThis property includes a set of properties related to proxy access.
SSLAcceptServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/base64 encoded).
StatusThis property includes the gRPC status code.
StatusDescriptionThis property includes a unicode string description of an error, which is physically encoded as UTF-8 followed by percent-encoding.
StatusLineThis property is the first line of the last server response.
TimeoutA timeout for the module.
TransferredDataThis property includes the contents of the last response from the server.
TransferredDataLimitThis property specifies the the maximum amount of data to be transferred.
TransferredHeadersThis property includes the complete set of headers as received from the server.
URLThis property includes the URL to post.
XCountThis property includes the number of packed fields or instances of the field specified by XPath .
XPathThis property provides a way to point to a specific field in the message.

Method List


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

BeginReadMessageThis method begins reading a message.
BeginReadPackedThis method begins reading a repeated packed field.
BeginWriteMessageThis method begins writing a new message.
BeginWritePackedThis method begins writing a new packed repeated field.
CalcAuthorizationThis method calculates the Authorization header based on provided credentials.
ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
EndReadMessageThis method ends reading a message.
EndReadPackedThis method ends reading a packed repeated field.
EndWriteMessageThis method ends writing a message.
EndWritePackedThis method ends writing a packed repeated field.
HasXPathThis method determines whether a specific element exists in the document.
InterruptInterrupt the current method.
PostThis method posts a message to the HTTP server using the HTTP POST method.
ReadBoolThis method reads the Boolean value from the current field number and returns it.
ReadBytesThis method reads the value of type byte from the current field number and returns it.
ReadDoubleThis method reads the value of type double from the current field number and returns it.
ReadFieldNumberThis method reads the next field number and returns it.
ReadFixed32This method reads the fixed int32 value from the current field number and returns it.
ReadFixed64This method reads the fixed int64 value from the current field number and returns it.
ReadFloatThis method reads the float value from the current field number and returns it.
ReadInt32This method reads the int32 value from the current field number and returns it.
ReadInt64This method reads the int64 value from the current field number and returns it.
ReadSint32This method reads the sint32 value from the current field number and returns it.
ReadSint64This method reads the sint64 value from the current field number and returns it.
ReadSkipThis method skips reading a value from the current field.
ReadStringThis method reads the string value from the current field number and returns it.
ResetReset the module.
TryXPathThis method navigates to the specified XPath if it exists.
WriteBoolThis method writes a Boolean value to the current field number.
WriteBytesThis method writes a value of type byte to the current field number.
WriteDoubleThis method writes a value of type double to the current field number.
WriteFieldNumberThis method specifies the field number to write.
WriteFixed32This method writes a fixed32 value to the current field number.
WriteFixed64This method writes a fixed64 value to the current field number.
WriteFloatThis method writes a float value to the current field number specified.
WriteInt32This method writes an int32 value to the current field number.
WriteInt64This method writes an int64 value to the current field number.
WriteSint32This method writes an sint32 value to the current field number.
WriteSint64This method writes an sint64 value to the current field number.
WriteStringThis method writes a string value to the current field number.

Event List


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

ConnectedThis event is fired immediately after a connection completes (or fails).
ConnectionStatusThis event is fired to indicate changes in the connection state.
DisconnectedThis event is fired when a connection is closed.
EndTransferThis event is fired when a document finishes transferring.
ErrorInformation about errors during data delivery.
LogThis event fires once for each log message.
MessageInThis event fires when a message response is sent by the server.
RedirectThis event is fired when a redirection is received from the server.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferThis event is fired when a document starts transferring (after the headers).
StatusThis event is fired when the HTTP status line is received from the server.
TransferThis event is fired while a document transfers (delivers document).

Config Settings


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

ContentTypeThe HTTP2 content-type header value.
HTTP2KeepaliveIntervalThe keepalive interval in seconds.
MessageDataHexThe hex encoded data for the current message.
UserAgentThe HTTP2 user-agent header value.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the module.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the module will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the module.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the module.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the module whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the module binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the module whether or not to use the system security libraries or an internal implementation.

Authorization Property (GRPC Module)

This is the authorization string to be sent to the server.

Syntax

public var authorization: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=authorization,setter=setAuthorization:) NSString* authorization;

- (NSString*)authorization;
- (void)setAuthorization :(NSString*)newAuthorization;

Default Value

""

Remarks

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

A common use for this property is to specify OAuth authorization string.

This property is provided whenever the server requires authorization.

Connected Property (GRPC Module)

This property shows whether the module is connected.

Syntax

public var connected: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=connected,setter=setConnected:) BOOL connected;

- (BOOL)connected;
- (void)setConnected :(BOOL)newConnected;

Default Value

False

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Firewall Property (GRPC Module)

A set of properties related to firewall access.

Syntax

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

 

Default Value

""

Remarks

XPath provides a simple way to navigate the fields within the received message using a subset of the XML XPath specification. The XPath property may be set to navigate to a specific field within the message structure. The HasXPath method may be used to determine whether or not an XPath exists before setting navigating to the location. The TryXPath method will attempt to navigate to the specified path and return True or False depending on the result.

XPath may be set to a series of one or more field accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location. After setting the XPath property, use any of the following methods to read data or information about the field at the selected path:

The following are possible values for a field accessor:

field_number The integer number of the field: for instance, /2 or /11
field_number[i] The i-th occurrence of the field specified by the field_number: for instance, /2[1] or /11[3]
[index] The field at the position specified by index: for instance, /[2] would select the second field, regardless of the field number
. The current location
.. The parent of the current location

Nested Messages

When a field of a message is itself another message, the fields of the submessage may be accessed by constructing an XPath to point to the submessage field. For example, /5/4 would move to field number 5 in the top-level message (which is itself a message), and then would move to field number 4 of the submessage.

Packed Repeated Fields

The following example shows the syntax to access values within packed repeated fields. The type of value within the packed repeated field must be known ahead of time. The XCount property can be used to obtain the number of values within the packed repeated field.

/10#v Select field number 10, which is a packed repeated field of type variant
/11#i Select field number 11, which is a packed repeated field of type fixed32
/12#l Select field number 12, which is a packed repeated field of type fixed64
/10#v[2] Select the 2nd value of field number 10, which is a packed repeated field of type variant
/11#v[2] Select the 2nd value of field number 11, which is a packed repeated field of type fixed32
/12#v[2] Select the 2nd value of field number 12, which is a packed repeated field of type fixed64

Example. Iterate through all values within a packed repeated field: gRPC.XPath = "/10#v"; int count = gRPC.XCount; for(int i=0;i<count;i++) { gRPC.XPath = "/10#v[ " + i.ToString() + "]"; Console.WriteLine(Int32.Parse(gRPC.ReadInt32())); }

FollowRedirects Property (GRPC Module)

This property determines what happens when the server issues a redirect.

Syntax

public var followRedirects: GrpcFollowRedirects {
  get {...}
  set {...}
}

public enum GrpcFollowRedirects: Int32 { case frNever = 0 case frAlways = 1 case frSameScheme = 2 }

@property (nonatomic,readwrite,assign,getter=followRedirects,setter=setFollowRedirects:) int followRedirects;

- (int)followRedirects;
- (void)setFollowRedirects :(int)newFollowRedirects;

Default Value

0

Remarks

This property 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 frAlways (1), the new URL for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URL scheme of the existing URL is the same.

If the new URL server is different from the existing one, Authorization is also reset to empty, unless this property is set to frAlways (1), 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 frNever (0). In this case, redirects are never followed, and the class instead.

GRPCTimeout Property (GRPC Module)

The gRPC timeout.

Syntax

public var grpcTimeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=GRPCTimeout,setter=setGRPCTimeout:) int GRPCTimeout;

- (int)GRPCTimeout;
- (void)setGRPCTimeout :(int)newGRPCTimeout;

Default Value

0

Remarks

This property specifies the value for the grpc-timeout header (in seconds). The default value is 0 (infinite), and the header is not sent in the request.

Idle Property (GRPC Module)

The current status of the module.

Syntax

public var idle: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=idle) BOOL idle;

- (BOOL)idle;

Default Value

True

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

MessageData Property (GRPC Module)

This property contains the message in a raw format.

Syntax

public var messageData: String {
  get {...}
}

public var messageDataB: Data { get {...} }

@property (nonatomic,readonly,assign,getter=messageData) NSString* messageData;

- (NSString*)messageData;

@property (nonatomic,readonly,assign,getter=messageDataB) NSData* messageDataB;

- (NSData*)messageDataB;

Default Value

""

Remarks

This property contains the message in a raw format. After calling Post, this property is populated with the message response from the server. When writing the message, this property will be populated with the fields of the message in a raw format.

This property is read-only.

OtherHeaders Property (GRPC Module)

This property includes other headers as determined by the user (optional).

Syntax

public var otherHeaders: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=otherHeaders,setter=setOtherHeaders:) NSString* otherHeaders;

- (NSString*)otherHeaders;
- (void)setOtherHeaders :(NSString*)newOtherHeaders;

Default Value

""

Remarks

This property 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 .

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

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

ParsedHeaders Property (GRPC Module)

This property includes a collection of headers returned from the last request.

Syntax

public var parsedHeaders: Array<Header> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=parsedHeaderCount) int parsedHeaderCount;

- (int)parsedHeaderCount;

- (NSString*)parsedHeaderField:(int)parsedHeaderIndex;

- (NSString*)parsedHeaderValue:(int)parsedHeaderIndex;

 

Default Value

""

Remarks

XPath provides a simple way to navigate the fields within the received message using a subset of the XML XPath specification. The XPath property may be set to navigate to a specific field within the message structure. The HasXPath method may be used to determine whether or not an XPath exists before setting navigating to the location. The TryXPath method will attempt to navigate to the specified path and return True or False depending on the result.

XPath may be set to a series of one or more field accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location. After setting the XPath property, use any of the following methods to read data or information about the field at the selected path:

The following are possible values for a field accessor:

field_number The integer number of the field: for instance, /2 or /11
field_number[i] The i-th occurrence of the field specified by the field_number: for instance, /2[1] or /11[3]
[index] The field at the position specified by index: for instance, /[2] would select the second field, regardless of the field number
. The current location
.. The parent of the current location

Nested Messages

When a field of a message is itself another message, the fields of the submessage may be accessed by constructing an XPath to point to the submessage field. For example, /5/4 would move to field number 5 in the top-level message (which is itself a message), and then would move to field number 4 of the submessage.

Packed Repeated Fields

The following example shows the syntax to access values within packed repeated fields. The type of value within the packed repeated field must be known ahead of time. The XCount property can be used to obtain the number of values within the packed repeated field.

/10#v Select field number 10, which is a packed repeated field of type variant
/11#i Select field number 11, which is a packed repeated field of type fixed32
/12#l Select field number 12, which is a packed repeated field of type fixed64
/10#v[2] Select the 2nd value of field number 10, which is a packed repeated field of type variant
/11#v[2] Select the 2nd value of field number 11, which is a packed repeated field of type fixed32
/12#v[2] Select the 2nd value of field number 12, which is a packed repeated field of type fixed64

Example. Iterate through all values within a packed repeated field: gRPC.XPath = "/10#v"; int count = gRPC.XCount; for(int i=0;i<count;i++) { gRPC.XPath = "/10#v[ " + i.ToString() + "]"; Console.WriteLine(Int32.Parse(gRPC.ReadInt32())); }

Proxy Property (GRPC Module)

This property includes a set of properties related to proxy access.

Syntax

public var proxy: Proxy {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

 

Default Value

""

Remarks

XPath provides a simple way to navigate the fields within the received message using a subset of the XML XPath specification. The XPath property may be set to navigate to a specific field within the message structure. The HasXPath method may be used to determine whether or not an XPath exists before setting navigating to the location. The TryXPath method will attempt to navigate to the specified path and return True or False depending on the result.

XPath may be set to a series of one or more field accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location. After setting the XPath property, use any of the following methods to read data or information about the field at the selected path:

The following are possible values for a field accessor:

field_number The integer number of the field: for instance, /2 or /11
field_number[i] The i-th occurrence of the field specified by the field_number: for instance, /2[1] or /11[3]
[index] The field at the position specified by index: for instance, /[2] would select the second field, regardless of the field number
. The current location
.. The parent of the current location

Nested Messages

When a field of a message is itself another message, the fields of the submessage may be accessed by constructing an XPath to point to the submessage field. For example, /5/4 would move to field number 5 in the top-level message (which is itself a message), and then would move to field number 4 of the submessage.

Packed Repeated Fields

The following example shows the syntax to access values within packed repeated fields. The type of value within the packed repeated field must be known ahead of time. The XCount property can be used to obtain the number of values within the packed repeated field.

/10#v Select field number 10, which is a packed repeated field of type variant
/11#i Select field number 11, which is a packed repeated field of type fixed32
/12#l Select field number 12, which is a packed repeated field of type fixed64
/10#v[2] Select the 2nd value of field number 10, which is a packed repeated field of type variant
/11#v[2] Select the 2nd value of field number 11, which is a packed repeated field of type fixed32
/12#v[2] Select the 2nd value of field number 12, which is a packed repeated field of type fixed64

Example. Iterate through all values within a packed repeated field: gRPC.XPath = "/10#v"; int count = gRPC.XCount; for(int i=0;i<count;i++) { gRPC.XPath = "/10#v[ " + i.ToString() + "]"; Console.WriteLine(Int32.Parse(gRPC.ReadInt32())); }

SSLAcceptServerCertEncoded Property (GRPC Module)

This is the certificate (PEM/base64 encoded).

Syntax

public var sslAcceptServerCertEncoded: String {
  get {...}
  set {...}
}

public var sslAcceptServerCertEncodedB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (GRPC Module)

This is the certificate (PEM/base64 encoded).

Syntax

public var sslCertEncoded: String {
  get {...}
  set {...}
}

public var sslCertEncodedB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (GRPC Module)

This is the name of the certificate store for the client certificate.

Syntax

public var sslCertStore: String {
  get {...}
  set {...}
}

public var sslCertStoreB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of 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.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

SSLCertStorePassword Property (GRPC Module)

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

Syntax

public var sslCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

Default Value

""

Remarks

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

SSLCertStoreType Property (GRPC Module)

This is the type of certificate store for this certificate.

Syntax

public var sslCertStoreType: GrpcSSLCertStoreTypes {
  get {...}
  set {...}
}

public enum GrpcSSLCertStoreTypes: Int32 { case cstUser = 0 case cstMachine = 1 case cstPFXFile = 2 case cstPFXBlob = 3 case cstJKSFile = 4 case cstJKSBlob = 5 case cstPEMKeyFile = 6 case cstPEMKeyBlob = 7 case cstPublicKeyFile = 8 case cstPublicKeyBlob = 9 case cstSSHPublicKeyBlob = 10 case cstP7BFile = 11 case cstP7BBlob = 12 case cstSSHPublicKeyFile = 13 case cstPPKFile = 14 case cstPPKBlob = 15 case cstXMLFile = 16 case cstXMLBlob = 17 case cstJWKFile = 18 case cstJWKBlob = 19 case cstSecurityKey = 20 case cstBCFKSFile = 21 case cstBCFKSBlob = 22 case cstAuto = 99 }

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

Default Value

0

Remarks

This is 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 property 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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; 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.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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.
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.

SSLCertSubject Property (GRPC Module)

This is the subject of the certificate used for client authentication.

Syntax

public var sslCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

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=support@nsoftware.com". Common fields and their meanings are displayed below.

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (GRPC Module)

This specifies the SSL/TLS implementation to use.

Syntax

public var sslProvider: GrpcSSLProviders {
  get {...}
  set {...}
}

public enum GrpcSSLProviders: Int32 { case sslpAutomatic = 0 case sslpPlatform = 1 case sslpInternal = 2 }

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

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:

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 will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (GRPC Module)

This is the certificate (PEM/base64 encoded).

Syntax

public var sslServerCertEncoded: String {
  get {...}
}

public var sslServerCertEncodedB: Data { get {...} }

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

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

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

Status Property (GRPC Module)

This property includes the gRPC status code.

Syntax

public var status: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=status) NSString* status;

- (NSString*)status;

Default Value

""

Remarks

This property contains the gRPC status code returned by the server when the request is sent through Post.

This property is read-only.

StatusDescription Property (GRPC Module)

This property includes a unicode string description of an error, which is physically encoded as UTF-8 followed by percent-encoding.

Syntax

public var statusDescription: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=statusDescription) NSString* statusDescription;

- (NSString*)statusDescription;

Default Value

""

Remarks

This property contains a unicode string description of any existing error, which is physically encoded as UTF-8 followed by percent-encoding. If there are no errors, the value of the property will be an empty string.

This property is read-only.

StatusLine Property (GRPC Module)

This property is the first line of the last server response.

Syntax

public var statusLine: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=statusLine) NSString* statusLine;

- (NSString*)statusLine;

Default Value

""

Remarks

This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the class, the error string is the same as the StatusLine property.

The HTTP protocol specifies the structure of the StatusLine as follows: [HTTP version] [Result Code] [Description].

This property is read-only.

Timeout Property (GRPC Module)

A timeout for the module.

Syntax

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

Default Value

60

Remarks

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

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class .

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

TransferredData Property (GRPC Module)

This property includes the contents of the last response from the server.

Syntax

public var transferredData: String {
  get {...}
}

public var transferredDataB: Data { get {...} }

@property (nonatomic,readonly,assign,getter=transferredData) NSString* transferredData;

- (NSString*)transferredData;

@property (nonatomic,readonly,assign,getter=transferredDataB) NSData* transferredDataB;

- (NSData*)transferredDataB;

Default Value

""

Remarks

This property contains the contents of the last response from the server. The data also can be received in the Transfer event.

TransferredDataLimit controls the maximum amount of data accumulated in TransferredData (by default, there is no limit).

This property is read-only.

TransferredDataLimit Property (GRPC Module)

This property specifies the the maximum amount of data to be transferred.

Syntax

public var transferredDataLimit: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=transferredDataLimit,setter=setTransferredDataLimit:) long long transferredDataLimit;

- (long long)transferredDataLimit;
- (void)setTransferredDataLimit :(long long)newTransferredDataLimit;

Default Value

0

Remarks

This property contains the maximum amount of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the TransferredData property.

TransferredHeaders Property (GRPC Module)

This property includes the complete set of headers as received from the server.

Syntax

public var transferredHeaders: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=transferredHeaders) NSString* transferredHeaders;

- (NSString*)transferredHeaders;

Default Value

""

Remarks

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

This property is read-only.

URL Property (GRPC Module)

This property includes the URL to post.

Syntax

public var url: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=URL,setter=setURL:) NSString* URL;

- (NSString*)URL;
- (void)setURL :(NSString*)newURL;

Default Value

""

Remarks

This property contains the URL of the document that is used during the Post operation.

XCount Property (GRPC Module)

This property includes the number of packed fields or instances of the field specified by XPath .

Syntax

public var xCount: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=XCount) int XCount;

- (int)XCount;

Default Value

0

Remarks

The XCount property can be used to obtain the number of values in a packed repeated field at the specified XPath. When XPath specifies a field that is not a packed repeated field, XCount will return the number of instances of the specified field. Even if the field is not a repeated field, it may still have multiple instances within the message, and XCount will reflect this number of instances.

Example. Using XCount and XPath to iterate through all values within a packed repeated field: gRPC.XPath = "/10#v"; int count = gRPC.XCount; for(int i=0;i<count;i++) { gRPC.XPath = "/10#v[ " + i.ToString() + "]"; Console.WriteLine(Int32.Parse(gRPC.ReadInt32())); }

This property is read-only.

XPath Property (GRPC Module)

This property provides a way to point to a specific field in the message.

Syntax

public var xPath: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=XPath,setter=setXPath:) NSString* XPath;

- (NSString*)XPath;
- (void)setXPath :(NSString*)newXPath;

Default Value

""

Remarks

XPath provides a simple way to navigate the fields within the received message using a subset of the XML XPath specification. The XPath property may be set to navigate to a specific field within the message structure. The HasXPath method may be used to determine whether or not an XPath exists before setting navigating to the location. The TryXPath method will attempt to navigate to the specified path and return True or False depending on the result.

XPath may be set to a series of one or more field accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location. After setting the XPath property, use any of the following methods to read data or information about the field at the selected path:

The following are possible values for a field accessor:

field_number The integer number of the field: for instance, /2 or /11
field_number[i] The i-th occurrence of the field specified by the field_number: for instance, /2[1] or /11[3]
[index] The field at the position specified by index: for instance, /[2] would select the second field, regardless of the field number
. The current location
.. The parent of the current location

Nested Messages

When a field of a message is itself another message, the fields of the submessage may be accessed by constructing an XPath to point to the submessage field. For example, /5/4 would move to field number 5 in the top-level message (which is itself a message), and then would move to field number 4 of the submessage.

Packed Repeated Fields

The following example shows the syntax to access values within packed repeated fields. The type of value within the packed repeated field must be known ahead of time. The XCount property can be used to obtain the number of values within the packed repeated field.

/10#v Select field number 10, which is a packed repeated field of type variant
/11#i Select field number 11, which is a packed repeated field of type fixed32
/12#l Select field number 12, which is a packed repeated field of type fixed64
/10#v[2] Select the 2nd value of field number 10, which is a packed repeated field of type variant
/11#v[2] Select the 2nd value of field number 11, which is a packed repeated field of type fixed32
/12#v[2] Select the 2nd value of field number 12, which is a packed repeated field of type fixed64

Example. Iterate through all values within a packed repeated field: gRPC.XPath = "/10#v"; int count = gRPC.XCount; for(int i=0;i<count;i++) { gRPC.XPath = "/10#v[ " + i.ToString() + "]"; Console.WriteLine(Int32.Parse(gRPC.ReadInt32())); }

BeginReadMessage Method (GRPC Module)

This method begins reading a message.

Syntax

public func beginReadMessage() throws -> Void
- (void)beginReadMessage;

Remarks

This method begins reading a new message and always must be called before starting to read a new message or a subtype field.

To read a message sequentially, first call BeginReadMessage. Next, call ReadFieldNumber to get the next field number. The component will move automatically to the next field number to read. Then call the appropriate method from the following list to read the field value:

Example 1. Read message: // Begins reading a new message grpc.BeginReadMessage(); // Gets the field number for the current field to read String CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the string value of field with field number 1 String stringField = grpc.ReadString(); // Gets the next field number CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the int32 value of the field int Int32Field = grpc.ReadInt32(); // Ends reading a message grpc.EndReadMessage();

If the field you want to read is a packed repeated field, then before calling any of the listed methods, call BeginReadPacked. BeginReadPacked returns the count of the repeated values. Call the ReadInt32 method to sequentially read each packed value. When done reading the packed repeated values, call EndReadPacked.

Example 2. Read message example, including a packed repeated field:

// Begins reading a new message grpc.BeginReadMessage(); // Gets the field number for the current field to read String CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the count of the packed repeated field int count = grpc.BeginReadPacked(0); int[] theValues = new int[count]; for(int i=0 ;i < count; i++) { // Get the values and store them in the theValues array theValues[i] = grpc.ReadInt32(); } // Ends reading a packed repeated field grpc.EndReadPacked(); // Ends reading a message grpc.EndReadMessage();

As a last step, call EndReadMessage.

BeginReadPacked Method (GRPC Module)

This method begins reading a repeated packed field.

Syntax

public func beginReadPacked(wireType: Int32) throws -> Int32
- (int)beginReadPacked:(int)wireType;

Remarks

This method begins reading a packed repeated field and always must be called before starting to read a packed repeated field. The wiretype of the elements must be specified in the WireType parameter. This method returns the number of elements of the packed repeated field.

To read a message sequentially, first call BeginReadMessage. Next, call ReadFieldNumber to get the next field number. The component will move automatically to the next field number to read. Then call the appropriate method from the following list to read the field value:

Example 1. Read message: // Begins reading a new message grpc.BeginReadMessage(); // Gets the field number for the current field to read String CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the string value of field with field number 1 String stringField = grpc.ReadString(); // Gets the next field number CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the int32 value of the field int Int32Field = grpc.ReadInt32(); // Ends reading a message grpc.EndReadMessage();

If the field you want to read is a packed repeated field, then before calling any of the listed methods, call BeginReadPacked. BeginReadPacked returns the count of the repeated values. Call the ReadInt32 method to sequentially read each packed value. When done reading the packed repeated values, call EndReadPacked.

Example 2. Read message example, including a packed repeated field:

// Begins reading a new message grpc.BeginReadMessage(); // Gets the field number for the current field to read String CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the count of the packed repeated field int count = grpc.BeginReadPacked(0); int[] theValues = new int[count]; for(int i=0 ;i < count; i++) { // Get the values and store them in the theValues array theValues[i] = grpc.ReadInt32(); } // Ends reading a packed repeated field grpc.EndReadPacked(); // Ends reading a message grpc.EndReadMessage();

As a last step, call EndReadMessage.

BeginWriteMessage Method (GRPC Module)

This method begins writing a new message.

Syntax

public func beginWriteMessage() throws -> Void
- (void)beginWriteMessage;

Remarks

This method begins writing a new message and always must be always called before starting to write a new message or a subtype field.

To write a message, first call BeginWriteMessage. Next, call WriteFieldNumber and pass the field number to write. Then call the appropriate method from the following list to write the field value.

  • WriteString
  • WriteInt32
  • WriteInt64
  • WriteFloat
  • WriteFixed32
  • WriteFixed64
  • WriteDouble
  • WriteBytes
  • WriteBool

Example 1. Write message: // Begins writing a new message grpc.BeginWriteMessage(); // Specifies the field number for the current field to write grpc.WriteFieldNumber(1); // Specifies the value of field with field number 1 grpc.WriteString("test"); grpc.WriteFieldNumber(2); grpc.WriteInt32(2); // Ends writing a message grpc.EndWriteMessage();

Example 2. Write message, including a packed repeated field: int[] RepeatedVarInt = new int[] { 3, 270, 86942 }; // Begins writing a new message grpc.BeginWriteMessage(); //Specifies the field number for the current field to write grpc.WriteFieldNumber(1); // Begins writing a packed repeated field grpc.BeginWritePacked(); for(int i=0 ;i < RepeatedVarInt.Length; i++) { // Write each packed value grpc.WriteInt32(RepeatedVarInt[i]); } // Ends writing a packed repeated field grpc.EndWritePacked(); // Ends writing a new message grpc.EndWriteMessage();

As a last step, call EndWriteMessage.

BeginWritePacked Method (GRPC Module)

This method begins writing a new packed repeated field.

Syntax

public func beginWritePacked() throws -> Void
- (void)beginWritePacked;

Remarks

This method begins writing a new packed repeated field and always must be called before starting to write a new packed repeated field.

To write a message, first call BeginWriteMessage. Next, call WriteFieldNumber and pass the field number to write. Then call the appropriate method from the following list to write the field value.

  • WriteString
  • WriteInt32
  • WriteInt64
  • WriteFloat
  • WriteFixed32
  • WriteFixed64
  • WriteDouble
  • WriteBytes
  • WriteBool

Example 1. Write message: // Begins writing a new message grpc.BeginWriteMessage(); // Specifies the field number for the current field to write grpc.WriteFieldNumber(1); // Specifies the value of field with field number 1 grpc.WriteString("test"); grpc.WriteFieldNumber(2); grpc.WriteInt32(2); // Ends writing a message grpc.EndWriteMessage();

Example 2. Write message, including a packed repeated field: int[] RepeatedVarInt = new int[] { 3, 270, 86942 }; // Begins writing a new message grpc.BeginWriteMessage(); //Specifies the field number for the current field to write grpc.WriteFieldNumber(1); // Begins writing a packed repeated field grpc.BeginWritePacked(); for(int i=0 ;i < RepeatedVarInt.Length; i++) { // Write each packed value grpc.WriteInt32(RepeatedVarInt[i]); } // Ends writing a packed repeated field grpc.EndWritePacked(); // Ends writing a new message grpc.EndWriteMessage();

As a last step, call EndWriteMessage.

CalcAuthorization Method (GRPC Module)

This method calculates the Authorization header based on provided credentials.

Syntax

public func calcAuthorization() throws -> Void
- (void)calcAuthorization;

Remarks

This method calculates the Authorization value using the values provided in AuthScheme, User, and Password.

In most cases, this method does not need to be called. The class will automatically calculate any required authorization values when a method is called, such as Get or Post.

This method may be useful in cases in which the Authorization value needs to be calculated before sending a request.

Config Method (GRPC Module)

Sets or retrieves a configuration setting.

Syntax

public func config(configurationString: String) throws -> String
- (NSString*)config:(NSString*)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.

DoEvents Method (GRPC Module)

Processes events from the internal message queue.

Syntax

public func doEvents() throws -> Void
- (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.

EndReadMessage Method (GRPC Module)

This method ends reading a message.

Syntax

public func endReadMessage() throws -> Void
- (void)endReadMessage;

Remarks

This method completes reading a message or a subtype field. The EndReadMessage method must be called after the message fields are specified. This method has a matching pair with the BeginReadMessage method. Each call to BeginReadMessage must have a matching call to EndReadMessage.

To read a message sequentially, first call BeginReadMessage. Next, call ReadFieldNumber to get the next field number. The component will move automatically to the next field number to read. Then call the appropriate method from the following list to read the field value:

Example 1. Read message: // Begins reading a new message grpc.BeginReadMessage(); // Gets the field number for the current field to read String CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the string value of field with field number 1 String stringField = grpc.ReadString(); // Gets the next field number CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the int32 value of the field int Int32Field = grpc.ReadInt32(); // Ends reading a message grpc.EndReadMessage();

If the field you want to read is a packed repeated field, then before calling any of the listed methods, call BeginReadPacked. BeginReadPacked returns the count of the repeated values. Call the ReadInt32 method to sequentially read each packed value. When done reading the packed repeated values, call EndReadPacked.

Example 2. Read message example, including a packed repeated field:

// Begins reading a new message grpc.BeginReadMessage(); // Gets the field number for the current field to read String CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the count of the packed repeated field int count = grpc.BeginReadPacked(0); int[] theValues = new int[count]; for(int i=0 ;i < count; i++) { // Get the values and store them in the theValues array theValues[i] = grpc.ReadInt32(); } // Ends reading a packed repeated field grpc.EndReadPacked(); // Ends reading a message grpc.EndReadMessage();

As a last step, call EndReadMessage.

EndReadPacked Method (GRPC Module)

This method ends reading a packed repeated field.

Syntax

public func endReadPacked() throws -> Void
- (void)endReadPacked;

Remarks

This method tells the component to end a packed repeated field reading operation. The EndReadPacked method must be called after the repeated values are specified. This method has a matching pair with the BeginReadPacked method. Each call to BeginReadPacked must have a matching call to EndReadPacked.

To read a message sequentially, first call BeginReadMessage. Next, call ReadFieldNumber to get the next field number. The component will move automatically to the next field number to read. Then call the appropriate method from the following list to read the field value:

Example 1. Read message: // Begins reading a new message grpc.BeginReadMessage(); // Gets the field number for the current field to read String CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the string value of field with field number 1 String stringField = grpc.ReadString(); // Gets the next field number CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the int32 value of the field int Int32Field = grpc.ReadInt32(); // Ends reading a message grpc.EndReadMessage();

If the field you want to read is a packed repeated field, then before calling any of the listed methods, call BeginReadPacked. BeginReadPacked returns the count of the repeated values. Call the ReadInt32 method to sequentially read each packed value. When done reading the packed repeated values, call EndReadPacked.

Example 2. Read message example, including a packed repeated field:

// Begins reading a new message grpc.BeginReadMessage(); // Gets the field number for the current field to read String CurrentFieldNumber = grpc.ReadFieldNumber(); // Gets the count of the packed repeated field int count = grpc.BeginReadPacked(0); int[] theValues = new int[count]; for(int i=0 ;i < count; i++) { // Get the values and store them in the theValues array theValues[i] = grpc.ReadInt32(); } // Ends reading a packed repeated field grpc.EndReadPacked(); // Ends reading a message grpc.EndReadMessage();

As a last step, call EndReadMessage.

EndWriteMessage Method (GRPC Module)

This method ends writing a message.

Syntax

public func endWriteMessage() throws -> Void
- (void)endWriteMessage;

Remarks

This method completes writing a message or a subtype field. The EndWriteMessage method must be called after the message fields are specified. This method has a matching pair with the BeginWriteMessage method. Each call to BeginWriteMessage must have a matching call to EndWriteMessage.

To write a message, first call BeginWriteMessage. Next, call WriteFieldNumber and pass the field number to write. Then call the appropriate method from the following list to write the field value.

  • WriteString
  • WriteInt32
  • WriteInt64
  • WriteFloat
  • WriteFixed32
  • WriteFixed64
  • WriteDouble
  • WriteBytes
  • WriteBool

Example 1. Write message: // Begins writing a new message grpc.BeginWriteMessage(); // Specifies the field number for the current field to write grpc.WriteFieldNumber(1); // Specifies the value of field with field number 1 grpc.WriteString("test"); grpc.WriteFieldNumber(2); grpc.WriteInt32(2); // Ends writing a message grpc.EndWriteMessage();

Example 2. Write message, including a packed repeated field: int[] RepeatedVarInt = new int[] { 3, 270, 86942 }; // Begins writing a new message grpc.BeginWriteMessage(); //Specifies the field number for the current field to write grpc.WriteFieldNumber(1); // Begins writing a packed repeated field grpc.BeginWritePacked(); for(int i=0 ;i < RepeatedVarInt.Length; i++) { // Write each packed value grpc.WriteInt32(RepeatedVarInt[i]); } // Ends writing a packed repeated field grpc.EndWritePacked(); // Ends writing a new message grpc.EndWriteMessage();

As a last step, call EndWriteMessage.

EndWritePacked Method (GRPC Module)

This method ends writing a packed repeated field.

Syntax

public func endWritePacked() throws -> Void
- (void)endWritePacked;

Remarks

This method tells the component to end a packed repeated field writing operation. The EndWritePacked method must be called after the repeated values are specified. This method has a matching pair with the BeginWritePacked method. Each call to BeginWritePacked must have a matching call to EndWritePacked.

To write a message, first call BeginWriteMessage. Next, call WriteFieldNumber and pass the field number to write. Then call the appropriate method from the following list to write the field value.

  • WriteString
  • WriteInt32
  • WriteInt64
  • WriteFloat
  • WriteFixed32
  • WriteFixed64
  • WriteDouble
  • WriteBytes
  • WriteBool

Example 1. Write message: // Begins writing a new message grpc.BeginWriteMessage(); // Specifies the field number for the current field to write grpc.WriteFieldNumber(1); // Specifies the value of field with field number 1 grpc.WriteString("test"); grpc.WriteFieldNumber(2); grpc.WriteInt32(2); // Ends writing a message grpc.EndWriteMessage();

Example 2. Write message, including a packed repeated field: int[] RepeatedVarInt = new int[] { 3, 270, 86942 }; // Begins writing a new message grpc.BeginWriteMessage(); //Specifies the field number for the current field to write grpc.WriteFieldNumber(1); // Begins writing a packed repeated field grpc.BeginWritePacked(); for(int i=0 ;i < RepeatedVarInt.Length; i++) { // Write each packed value grpc.WriteInt32(RepeatedVarInt[i]); } // Ends writing a packed repeated field grpc.EndWritePacked(); // Ends writing a new message grpc.EndWriteMessage();

As a last step, call EndWriteMessage.

HasXPath Method (GRPC Module)

This method determines whether a specific element exists in the document.

Syntax

public func hasXPath(xPath: String) throws -> Bool
- (BOOL)hasXPath:(NSString*)XPath;

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check whether or not a path exists before setting it through XPath.

This method returns True if the xpath exists, and False if not.

See XPath for details on the XPath syntax.

Interrupt Method (GRPC Module)

Interrupt the current method.

Syntax

public func interrupt() throws -> Void
- (void)interrupt;

Remarks

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

Post Method (GRPC Module)

This method posts a message to the HTTP server using the HTTP POST method.

Syntax

public func post(url: String) throws -> Void
- (void)post:(NSString*)URL;

Remarks

This method posts data to the HTTP server using the HTTP POST method. Posted message data are constructed using the Write* methods. The server response text is received through the Transfer event and will be available in the MessageData property. The message response can be read with the component by using the MessageIn event. See the introduction page for details.

Example. Performing a post:

grpc.BeginWriteMessage(); grpc.WriteFieldNumber(1); grpc.WriteString("test"); grpc.WriteFieldNumber(2); grpc.WriteInt32(2); grpc.EndWriteMessage(); GRPC.Post(myurl)

ReadBool Method (GRPC Module)

This method reads the Boolean value from the current field number and returns it.

Syntax

public func readBool() throws -> Bool
- (BOOL)readBool;

Remarks

This method reads the Boolean value of the current field number and returns it. The current field number is specified by the component when calling ReadFieldNumber.

The ReadFieldNumber method must be called before calling ReadBool.

ReadBytes Method (GRPC Module)

This method reads the value of type byte from the current field number and returns it.

Syntax

public func readBytes() throws -> Data
- (NSData*)readBytes;

Remarks

This method reads the value of type byte from the current field number and returns it. The current field number is specified by the component when calling ReadFieldNumber.

The ReadFieldNumber method must be called before calling ReadBytes.

ReadDouble Method (GRPC Module)

This method reads the value of type double from the current field number and returns it.

Syntax

public func readDouble() throws -> String
- (NSString*)readDouble;

Remarks

This method reads the value of type double from the current field number and returns it. The current field number is specified by the component when calling ReadFieldNumber.

The ReadFieldNumber method must be called before calling ReadDouble.

ReadFieldNumber Method (GRPC Module)

This method reads the next field number and returns it.

Syntax

public func readFieldNumber() throws -> Int32
- (int)readFieldNumber;

Remarks

This method reads the next field number and returns it. The ReadFieldNumber method must be called before reading the value of the field.

ReadFixed32 Method (GRPC Module)

This method reads the fixed int32 value from the current field number and returns it.

Syntax

public func readFixed32() throws -> Int32
- (int)readFixed32;

Remarks

This method reads the fixed int32 value from the current field number and returns it. The current field number is specified by the component when calling ReadFieldNumber.

The ReadFieldNumber method must be called before calling ReadFixed32.

ReadFixed64 Method (GRPC Module)

This method reads the fixed int64 value from the current field number and returns it.

Syntax

public func readFixed64() throws -> Int64
- (long long)readFixed64;

Remarks

This method reads the fixed int64 value from the current field number and returns it. The current field number is specified by the component when calling ReadFieldNumber.

The ReadFieldNumber method must be called before calling ReadFixed64.

ReadFloat Method (GRPC Module)

This method reads the float value from the current field number and returns it.

Syntax

public func readFloat() throws -> String
- (NSString*)readFloat;

Remarks

This method reads the float value from the current field number and returns it. The current field number is specified by the component when calling ReadFieldNumber.

The ReadFieldNumber method must be called before calling ReadFloat.

ReadInt32 Method (GRPC Module)

This method reads the int32 value from the current field number and returns it.

Syntax

public func readInt32() throws -> Int32
- (int)readInt32;

Remarks

This method reads the int32 value from the current field number and returns it. The current field number is specified by the component when calling ReadFieldNumber.

The ReadFieldNumber method must be called before calling ReadInt32.

ReadInt64 Method (GRPC Module)

This method reads the int64 value from the current field number and returns it.

Syntax

public func readInt64() throws -> Int64
- (long long)readInt64;

Remarks

This method reads the int64 value from the current field number and returns it. The current field number is specified by the component when calling ReadFieldNumber.

The ReadFieldNumber method must be called before calling ReadInt64.

ReadSint32 Method (GRPC Module)

This method reads the sint32 value from the current field number and returns it.

Syntax

public func readSint32() throws -> Int32
- (int)readSint32;

Remarks

This method reads the sint32 value from the current field number and returns it. The current field number is specified by the component when calling ReadFieldNumber.

The ReadFieldNumber method must be called before calling ReadInt32.

ReadSint64 Method (GRPC Module)

This method reads the sint64 value from the current field number and returns it.

Syntax

public func readSint64() throws -> Int64
- (long long)readSint64;

Remarks

This method reads the sint64 value from the current field number and returns it. The current field number is specified by the component when calling ReadFieldNumber.

The ReadFieldNumber method must be called before calling ReadInt32.

ReadSkip Method (GRPC Module)

This method skips reading a value from the current field.

Syntax

public func readSkip() throws -> Void
- (void)readSkip;

Remarks

This method skips reading a value from the current field specified by ReadFieldNumber. ReadSkip might be useful in cases in which you do not want to read the value of a particular field.

Example. Using ReadSkip to skip reading the field with the field number 2: // Begins reading a message grpc.BeginReadMessage(); // Loop to get the field number // After all fields are traversed ReadFieldNumber will return 0 while ((num = grpc.ReadFieldNumber()) > 0) { switch (num) { case 1: Name = grpc.ReadString(); break; case 2: // ReadSkip is used to skip reading value with field number 2 grpc.ReadSkip(); break; case 3: Num64 = grpc.ReadInt64(); break; } // Ends reading a message grpc.EndReadMessage();

ReadString Method (GRPC Module)

This method reads the string value from the current field number and returns it.

Syntax

public func readString() throws -> String
- (NSString*)readString;

Remarks

This method reads the string value from the current field number and returns it. The current field number is specified by the component when calling ReadFieldNumber.

The ReadFieldNumber method must be called before calling ReadString.

Reset Method (GRPC Module)

Reset the component.

Syntax

public func reset() throws -> Void
- (void)reset;

Remarks

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

TryXPath Method (GRPC Module)

This method navigates to the specified XPath if it exists.

Syntax

public func tryXPath(xpath: String) throws -> Bool
- (BOOL)tryXPath:(NSString*)xpath;

Remarks

This method will attempt to navigate to the specified XPath parameter if it exists within the document.

If the XPath exists, the XPath property will be updated, and the method will return True.

If the XPath does not exist, the XPath property will not be updated, and the method will return False.

WriteBool Method (GRPC Module)

This method writes a Boolean value to the current field number.

Syntax

public func writeBool(value: Bool) throws -> Void
- (void)writeBool:(BOOL)value;

Remarks

This method is used to write a Boolean value to the current field number. The current field number must be specified with the WriteFieldNumber method before calling this method.

The Boolean value must be passed to the value parameter.

WriteBytes Method (GRPC Module)

This method writes a value of type byte to the current field number.

Syntax

public func writeBytes(value: Data) throws -> Void
- (void)writeBytes:(NSData*)value;

Remarks

This method is used to write a value of type byte to the current field number. The current field number must be specified with the WriteFieldNumber method before calling this method.

The value of type byte must be passed to the value parameter.

WriteDouble Method (GRPC Module)

This method writes a value of type double to the current field number.

Syntax

public func writeDouble(value: String) throws -> Void
- (void)writeDouble:(NSString*)value;

Remarks

This method is used to write a value of type double to the current field number. The current field number must be specified with the WriteFieldNumber method before calling this method.

The value of type double must be passed to the value parameter.

WriteFieldNumber Method (GRPC Module)

This method specifies the field number to write.

Syntax

public func writeFieldNumber(value: Int32) throws -> Void
- (void)writeFieldNumber:(int)value;

Remarks

This method tells the component which message field number to write. The field number must be passed to the value parameter.

This method must be called before writing the field value.

WriteFixed32 Method (GRPC Module)

This method writes a fixed32 value to the current field number.

Syntax

public func writeFixed32(value: Int32) throws -> Void
- (void)writeFixed32:(int)value;

Remarks

This method is used to write a fixed32 value to the current field number. The current field number must be specified with the WriteFieldNumber method before calling this method.

The fixed32 value must be passed to the value parameter.

WriteFixed64 Method (GRPC Module)

This method writes a fixed64 value to the current field number.

Syntax

public func writeFixed64(value: Int64) throws -> Void
- (void)writeFixed64:(long long)value;

Remarks

This method is used to write a fixed64 value to the current field number. The current field number must be specified with the WriteFieldNumber method before calling this method.

The fixed64 value must be passed to the value parameter.

WriteFloat Method (GRPC Module)

This method writes a float value to the current field number specified.

Syntax

public func writeFloat(value: String) throws -> Void
- (void)writeFloat:(NSString*)value;

Remarks

This method is used to write a float value to the current field number. The current field number must be specified with the WriteFieldNumber method before calling this method.

The float value must be passed to the value parameter.

WriteInt32 Method (GRPC Module)

This method writes an int32 value to the current field number.

Syntax

public func writeInt32(value: Int32) throws -> Void
- (void)writeInt32:(int)value;

Remarks

This method is used to write an int32 value to the current field number. The current field number must be specified with the WriteFieldNumber method before calling this method.

The int32 value must be passed to the value parameter.

WriteInt64 Method (GRPC Module)

This method writes an int64 value to the current field number.

Syntax

public func writeInt64(value: Int64) throws -> Void
- (void)writeInt64:(long long)value;

Remarks

This method is used to write an int64 value to the current field number. The current field number must be specified with the WriteFieldNumber method before calling this method.

The int64 value must be passed to the value parameter.

WriteSint32 Method (GRPC Module)

This method writes an sint32 value to the current field number.

Syntax

public func writeSint32(value: Int32) throws -> Void
- (void)writeSint32:(int)value;

Remarks

This method is used to write an sint32 value to the current field number. The current field number must be specified with the WriteFieldNumber method before calling this method.

The sint32 value must be passed to the value parameter.

WriteSint64 Method (GRPC Module)

This method writes an sint64 value to the current field number.

Syntax

public func writeSint64(value: Int64) throws -> Void
- (void)writeSint64:(long long)value;

Remarks

This method is used to write an sint64 value to the current field number. The current field number must be specified with the WriteFieldNumber method before calling this method.

The sint364 value must be passed to the value parameter.

WriteString Method (GRPC Module)

This method writes a string value to the current field number.

Syntax

public func writeString(value: String) throws -> Void
- (void)writeString:(NSString*)value;

Remarks

This method is used to write a string value to the current field number. The current field number must be specified with the WriteFieldNumber method before calling this method.

The string value must be passed to the value parameter.

Connected Event (GRPC Module)

This event is fired immediately after a connection completes (or fails).

Syntax

func onConnected(statusCode: Int32, description: String)
- (void)onConnected:(int)statusCode :(NSString*)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 (GRPC Module)

This event is fired to indicate changes in the connection state.

Syntax

func onConnectionStatus(connectionEvent: String, statusCode: Int32, description: String)
- (void)onConnectionStatus:(NSString*)connectionEvent :(int)statusCode :(NSString*)description;

Remarks

The ConnectionStatus 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.

Disconnected Event (GRPC Module)

This event is fired when a connection is closed.

Syntax

func onDisconnected(statusCode: Int32, description: String)
- (void)onDisconnected:(int)statusCode :(NSString*)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 (GRPC Module)

This event is fired when a document finishes transferring.

Syntax

func onEndTransfer(direction: Int32)
- (void)onEndTransfer:(int)direction;

Remarks

The EndTransfer 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 (GRPC Module)

Information about errors during data delivery.

Syntax

func onError(errorCode: Int32, description: String)
- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

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

Log Event (GRPC Module)

This event fires once for each log message.

Syntax

func onLog(logLevel: Int32, message: String, logType: String)
- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)logType;

Remarks

This event fires 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"

MessageIn Event (GRPC Module)

This event fires when a message response is sent by the server.

Syntax

func onMessageIn(compressed: Bool, messageLength: Int32)
- (void)onMessageIn:(BOOL)compressed :(int)messageLength;

Remarks

This event fires for every message response sent by the server after calling Post. Every time this event fires, the MessageData property is populated with the raw data of the response.

Compressed is a Boolean indicating whether or not the message is in a compressed state.

The length of the message is shown by MessageLength.

Redirect Event (GRPC Module)

This event is fired when a redirection is received from the server.

Syntax

func onRedirect(location: String, accept: inout Bool)
- (void)onRedirect:(NSString*)location :(int*)accept;

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 . Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SSLServerAuthentication Event (GRPC Module)

Fired after the server presents its certificate to the client.

Syntax

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)
- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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 (GRPC Module)

Shows the progress of the secure connection.

Syntax

func onSSLStatus(message: String)
- (void)onSSLStatus:(NSString*)message;

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (GRPC Module)

This event is fired when a document starts transferring (after the headers).

Syntax

func onStartTransfer(direction: Int32)
- (void)onStartTransfer:(int)direction;

Remarks

The StartTransfer 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 (GRPC Module)

This event is fired when the HTTP status line is received from the server.

Syntax

func onStatus(httpVersion: String, statusCode: Int32, description: String)
- (void)onStatus:(NSString*)HTTPVersion :(int)statusCode :(NSString*)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 (GRPC Module)

This event is fired while a document transfers (delivers document).

Syntax

func onTransfer(direction: Int32, bytesTransferred: Int64, percentDone: Int32, text: Data)
- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)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.

Firewall Type

This is the firewall the component will connect through.

Remarks

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

Fields

autoDetect
Bool

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewallType
FirewallTypes

This property determines 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. is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. is set to 1080.

host
String

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

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

password
String

This property contains a password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .

port
Int32

This property contains the transmission control protocol (TCP) port for the firewall . See the description of the property for details.

Note: This property is set automatically when is set to a valid value. See the description of the property for details.

user
String

This property contains a user name if authentication is to be used connecting through a firewall. If the is specified, this property and properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class .

Constructors

public init()

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .

Fields

field
String

This property contains the name of the HTTP Header (this is the same case as it is delivered).

value
String

This property contains the Header contents.

Constructors

public init()
public init(field: , value: )

Proxy Type

This is the proxy the component will connect to.

Remarks

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

Fields

authScheme
ProxyAuthSchemes

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the and properties are set.

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

By default, is authBasic (0), and if the and properties are set, the component will attempt basic authentication.

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

If 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 is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of and .

autoDetect
Bool

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is .

password
String

This property contains a password if authentication is to be used for the proxy.

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

If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.

If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.

port
Int32

This property contains the Transmission Control Protocol (TCP) port for the proxy (default 80). See the description of the property for details.

server
String

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

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

ssl
ProxySSLTypes

This property determines 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

This property contains a user name, if authentication is to be used for the proxy.

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

If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.

If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.

Constructors

public init()
public init(server: , port: )
public init(server: , port: , user: , password: )

Config Settings (GRPC Module)

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.

GRPC Config Settings

ContentType:   The HTTP2 content-type header value.

This configuration setting specifies the content-type header value that is sent in the request. The default value is application/grpc+proto.

HTTP2KeepaliveInterval:   The keepalive interval in seconds.

This configuration setting specifies interval, in seconds, between HTTP2 keepalives. The keepalives are sent as an HTTP2 PING frame. The default value is 0 and keepalives will not be sent.

MessageDataHex:   The hex encoded data for the current message.

This configuration setting may be queried at any time and will return the hex-encoded message data as a string. This is useful to obtain the raw message bytes in a string format that can be easily transmitted for storage or debugging purposes. This typically is useful only when it is necessary to record the raw message data for processing outside of the component.

UserAgent:   The HTTP2 user-agent header value.

This configuration setting specifies the user-agent header value that is sent in the request. The default value is grpc-cpp/20.0.

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 if the server does not support HTTP/2.

The default value is True.

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 component 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 .

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 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 component 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"), 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/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 component 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 component 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. You also may explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to Connection: Keep-Alive. 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).

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 .

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 ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

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

This configuration setting is provided for use by classs 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 classs that do not directly expose Proxy properties.

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

This configuration setting is provided for use by classs 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 classs 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 classs 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.

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. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.

UserAgent:   Information about the user agent (browser).

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

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

TCPClient Config Settings

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.

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 classs 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 classs that do not directly expose Firewall properties.

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 .

Note: This setting is provided for use by classs 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 classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate 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 classs 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 .

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

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 multi-homed 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 classs) 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 multi-homed hosts (machines with more than one IP interface).

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

This 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; setting is useful when trying to connect to services that require a trusted port in 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.nsoftware.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 true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config 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:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

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

When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful 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 setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

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 certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

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

This setting specifies whether the class will check the Certificate Revocation List 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 .

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 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 only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength 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.

Please note that this 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 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 config setting.

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

The enabled 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.

Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when SSLProvider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include:
  • 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_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • 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.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

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

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation.

In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

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

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above 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.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

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

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

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

This 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.

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

This 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 traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

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

SSLNegotiatedCipher:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

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

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength.

Returns the strength of the ciphersuite negotiated during the SSL handshake.

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

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake represented as a single string.

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

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

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

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

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

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

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

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

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

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

This setting optionally specifies one or more CA certificates to be used when 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 setting should only be set 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 setting is a newline (CrLf) separated list of certificates. For instance:

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

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

This 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 setting. If the server certificate signature algorithm is unsupported the class .

The format of this value is a comma separated list of hash-signature combinations. For instance: TCPClient.SSLProvider = TCPClientSSLProviders.sslpInternal; TCPClient.Config("SSLEnabledProtocols=3072"); //TLS 1.2 TCPClient.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this 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.

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

TLS12SupportedGroups:   The supported groups for ECC.

This 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 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 round trip 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 setting.

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

In most cases this setting does not need to be modified. This should only be modified 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 setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "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 setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified 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

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)

Socket Config Settings

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

If AbsoluteTimeout is set to True, any method which 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 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 TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

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. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

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.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

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.
UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (GRPC Module)

HTTP Errors

118   Firewall Error. Error description contains 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   Can't 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.
302   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 non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't 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] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory 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 not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2022 macOS Edition - Version 22.0 [Build 8369]