GRPC Class
Properties Methods Events Configuration Settings Errors
The GRPC Class is designed to send and receive messages over gRPC. The class can be used to both create messages to send as well as read incoming messages.
Syntax
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 component does not currently process or generate .proto files. It is up to the developer to know the expected structure of the data. 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:
- ReadBool
- ReadBytes
- ReadDouble
- ReadFieldNumber
- ReadFixed32
- ReadFixed64
- ReadFloat
- ReadInt32
- ReadInt64
- ReadString
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 class with short descriptions. Click on the links for further details.
Authorization | This is the authorization string to be sent to the server. |
Connected | This property shows whether the class is connected. |
FirewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the transmission control protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
FollowRedirects | This property determines what happens when the server issues a redirect. |
GRPCTimeout | The gRPC timeout. |
Idle | The current status of the class. |
MessageData | This property contains the message in a raw format. |
OtherHeaders | This property includes other headers as determined by the user (optional). |
ParsedHeaderCount | The number of records in the ParsedHeader arrays. |
ParsedHeaderField | This property contains the name of the HTTP header (this is the same case as it is delivered). |
ParsedHeaderValue | This property contains the header contents. |
ProxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use SSL for the connection to the proxy. |
ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCertEncoded | This is the certificate (PEM/base64 encoded). |
Status | This property includes the gRPC status code. |
StatusDescription | This property includes a unicode string description of an error, which is physically encoded as UTF-8 followed by percent-encoding. |
StatusLine | The first line of the last server response. |
Timeout | A timeout for the class. |
TransferredData | This property includes the contents of the last response from the server. |
TransferredDataLimit | The maximum of data to be transferred. |
TransferredHeaders | This property includes the complete set of headers as received from the server. |
URL | This property includes the URL to post. |
XCount | This property includes the number of packed fields or instances of the field specified by XPath . |
XPath | This 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 class with short descriptions. Click on the links for further details.
BeginReadMessage | This method begins reading a message. |
BeginReadPacked | This method begins reading a repeated packed field. |
BeginWriteMessage | This method begins writing a new message. |
BeginWritePacked | This method begins writing a new packed repeated field. |
CalcAuthorization | Calculates the Authorization header based on provided credentials. |
Config | Sets or retrieves a configuration setting. |
DoEvents | Processes events from the internal message queue. |
EndReadMessage | This method ends reading a message. |
EndReadPacked | This method ends reading a packed repeated field. |
EndWriteMessage | This method ends writing a message. |
EndWritePacked | This method ends writing a packed repeated field. |
HasXPath | This method determines whether a specific element exists in the document. |
Interrupt | Interrupt the current method. |
Post | This method posts a message to the HTTP server using the HTTP POST method. |
ReadBool | This method reads the Boolean value from the current field number and returns it. |
ReadBytes | This method reads the value of type byte from the current field number and returns it. |
ReadDouble | This method reads the value of type double from the current field number and returns it. |
ReadFieldNumber | This method reads the next field number and returns it. |
ReadFixed32 | This method reads the fixed int32 value from the current field number and returns it. |
ReadFixed64 | This method reads the fixed int64 value from the current field number and returns it. |
ReadFloat | This method reads the float value from the current field number and returns it. |
ReadInt32 | This method reads the int32 value from the current field number and returns it. |
ReadInt64 | This method reads the int64 value from the current field number and returns it. |
ReadSint32 | This method reads the sint32 value from the current field number and returns it. |
ReadSint64 | This method reads the sint64 value from the current field number and returns it. |
ReadSkip | This method skips reading a value from the current field. |
ReadString | This method reads the string value from the current field number and returns it. |
Reset | Reset the class. |
TryXPath | This method navigates to the specified XPath if it exists. |
WriteBool | This method writes a Boolean value to the current field number. |
WriteBytes | This method writes a value of type byte to the current field number. |
WriteDouble | This method writes a value of type double to the current field number. |
WriteFieldNumber | This method specifies the field number to write. |
WriteFixed32 | This method writes a fixed32 value to the current field number. |
WriteFixed64 | This method writes a fixed64 value to the current field number. |
WriteFloat | This method writes a float value to the current field number specified. |
WriteInt32 | This method writes an int32 value to the current field number. |
WriteInt64 | This method writes an int64 value to the current field number. |
WriteSint32 | This method writes an sint32 value to the current field number. |
WriteSint64 | This method writes an sint64 value to the current field number. |
WriteString | This method writes a string value to the current field number. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Connected | Fired immediately after a connection completes (or fails). |
ConnectionStatus | Fired to indicate changes in connection state. |
Disconnected | Fired when a connection is closed. |
EndTransfer | Fired when a document finishes transferring. |
Error | Information about errors during data delivery. |
Log | Fires once for each log message. |
MessageIn | This event fires when a message response is sent by the server. |
Redirect | Fired when a redirection is received from the server. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartTransfer | Fired when a document starts transferring (after the headers). |
Status | Fired when the HTTP status line is received from the server. |
Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
ContentType | The HTTP2 content-type header value. |
HTTP2KeepaliveInterval | The keepalive interval in seconds. |
MessageDataHex | The hex encoded data for the current message. |
UserAgent | The HTTP2 user-agent header value. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to true the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
Authorization Property (GRPC Class)
This is the authorization string to be sent to the server.
Syntax
QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);
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.
Data Type
String
Connected Property (GRPC Class)
This property shows whether the class is connected.
Syntax
bool GetConnected();
int SetConnected(bool bConnected);
Default Value
false
Remarks
This property is used to determine whether or not the class is connected to the remote host.
This property is not available at design time.
Data Type
Boolean
FirewallAutoDetect Property (GRPC Class)
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Syntax
bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);
Default Value
false
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (GRPC Class)
This property determines the type of firewall to connect through.
Syntax
int GetFirewallType();
int SetFirewallType(int iFirewallType);
Possible Values
FW_NONE(0),
FW_TUNNEL(1),
FW_SOCKS4(2),
FW_SOCKS5(3),
FW_SOCKS4A(10)
Default Value
0
Remarks
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. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (GRPC Class)
This property contains the name or IP address of firewall (optional).
Syntax
QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);
Default Value
""
Remarks
This property contains the name or IP address of firewall (optional). If a FirewallHost 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 fails with an error.
Data Type
String
FirewallPassword Property (GRPC Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Data Type
String
FirewallPort Property (GRPC Class)
This property contains the transmission control protocol (TCP) port for the firewall Host .
Syntax
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);
Default Value
0
Remarks
This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (GRPC Class)
This property contains a user name if authentication is to be used connecting through a firewall.
Syntax
QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);
Default Value
""
Remarks
This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Data Type
String
FollowRedirects Property (GRPC Class)
This property determines what happens when the server issues a redirect.
Syntax
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);
Possible Values
FR_NEVER(0),
FR_ALWAYS(1),
FR_SAME_SCHEME(2)
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 fails with an error instead.
Data Type
Integer
GRPCTimeout Property (GRPC Class)
The gRPC timeout.
Syntax
int GetGRPCTimeout();
int SetGRPCTimeout(int iGRPCTimeout);
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.
Data Type
Integer
Idle Property (GRPC Class)
The current status of the class.
Syntax
bool GetIdle();
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.
Data Type
Boolean
MessageData Property (GRPC Class)
This property contains the message in a raw format.
Syntax
QByteArray GetMessageData();
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.
Data Type
Byte Array
OtherHeaders Property (GRPC Class)
This property includes other headers as determined by the user (optional).
Syntax
QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);
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 CRLF ("\r\n") .
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.
This property is not available at design time.
Data Type
String
ParsedHeaderCount Property (GRPC Class)
The number of records in the ParsedHeader arrays.
Syntax
int GetParsedHeaderCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ParsedHeaderCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
ParsedHeaderField Property (GRPC Class)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Syntax
QString GetParsedHeaderField(int iParsedHeaderIndex);
Default Value
""
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
ParsedHeaderValue Property (GRPC Class)
This property contains the header contents.
Syntax
QString GetParsedHeaderValue(int iParsedHeaderIndex);
Default Value
""
Remarks
This property contains the Header contents.
The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
ProxyAuthScheme Property (GRPC Class)
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Syntax
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);
Possible Values
AUTH_BASIC(0),
AUTH_DIGEST(1),
AUTH_PROPRIETARY(2),
AUTH_NONE(3),
AUTH_NTLM(4),
AUTH_NEGOTIATE(5)
Default Value
0
Remarks
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is only used when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme 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 ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (GRPC Class)
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Syntax
bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);
Default Value
false
Remarks
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Data Type
Boolean
ProxyPassword Property (GRPC Class)
This property contains a password if authentication is to be used for the proxy.
Syntax
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);
Default Value
""
Remarks
This property contains a password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (GRPC Class)
This property contains the TCP port for the proxy Server (default 80).
Syntax
int GetProxyPort();
int SetProxyPort(int iProxyPort);
Default Value
80
Remarks
This property contains the TCP port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (GRPC Class)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);
Default Value
""
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (GRPC Class)
This property determines when to use SSL for the connection to the proxy.
Syntax
int GetProxySSL();
int SetProxySSL(int iProxySSL);
Possible Values
PS_AUTOMATIC(0),
PS_ALWAYS(1),
PS_NEVER(2),
PS_TUNNEL(3)
Default Value
0
Remarks
This property determines when to use SSL for the connection to the proxy. The applicable values are the following:
psAutomatic (0) | Default setting. If the URL is an "https" URL, the class will use the psTunnel option. If the URL is a "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 through a tunneling (HTTP) proxy. |
Data Type
Integer
ProxyUser Property (GRPC Class)
This property contains a user name, if authentication is to be used for the proxy.
Syntax
QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);
Default Value
""
Remarks
This property contains a user name, if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
SSLAcceptServerCertEncoded Property (GRPC Class)
This is the certificate (PEM/base64 encoded).
Syntax
QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);
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.
This property is not available at design time.
Data Type
Byte Array
SSLCertEncoded Property (GRPC Class)
This is the certificate (PEM/base64 encoded).
Syntax
QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
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.
This property is not available at design time.
Data Type
Byte Array
SSLCertStore Property (GRPC Class)
This is the name of the certificate store for the client certificate.
Syntax
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);
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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root 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).
Data Type
Byte Array
SSLCertStorePassword Property (GRPC Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);
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.
Data Type
String
SSLCertStoreType Property (GRPC Class)
This is the type of certificate store for this certificate.
Syntax
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_AUTO(99)
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
|
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. |
Data Type
Integer
SSLCertSubject Property (GRPC Class)
This is the subject of the certificate used for client authentication.
Syntax
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);
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.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
Data Type
String
SSLProvider Property (GRPC Class)
This specifies the SSL/TLS implementation to use.
Syntax
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);
Possible Values
SSLP_AUTOMATIC(0),
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
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, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.
Data Type
Integer
SSLServerCertEncoded Property (GRPC Class)
This is the certificate (PEM/base64 encoded).
Syntax
QByteArray GetSSLServerCertEncoded();
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 and not available at design time.
Data Type
Byte Array
Status Property (GRPC Class)
This property includes the gRPC status code.
Syntax
QString GetStatus();
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.
Data Type
String
StatusDescription Property (GRPC Class)
This property includes a unicode string description of an error, which is physically encoded as UTF-8 followed by percent-encoding.
Syntax
QString GetStatusDescription();
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.
Data Type
String
StatusLine Property (GRPC Class)
The first line of the last server response.
Syntax
QString GetStatusLine();
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: [HTTP version] [Result Code] [Description].
This property is read-only and not available at design time.
Data Type
String
Timeout Property (GRPC Class)
A timeout for the class.
Syntax
int GetTimeout();
int SetTimeout(int iTimeout);
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 fails with an error.
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.
Data Type
Integer
TransferredData Property (GRPC Class)
This property includes the contents of the last response from the server.
Syntax
QByteArray GetTransferredData();
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 and not available at design time.
Data Type
Byte Array
TransferredDataLimit Property (GRPC Class)
The maximum of data to be transferred.
Syntax
qint64 GetTransferredDataLimit();
int SetTransferredDataLimit(qint64 lTransferredDataLimit);
Default Value
0
Remarks
This property contains the maximum 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.
Data Type
Long64
TransferredHeaders Property (GRPC Class)
This property includes the complete set of headers as received from the server.
Syntax
QString GetTransferredHeaders();
Default Value
""
Remarks
This property returns the complete set of raw headers as received from the server.
This property is read-only and not available at design time.
Data Type
String
URL Property (GRPC Class)
This property includes the URL to post.
Syntax
QString GetURL();
int SetURL(QString qsURL);
Default Value
""
Remarks
This property contains the URL of the document that is used during the Post operation.
Data Type
String
XCount Property (GRPC Class)
This property includes the number of packed fields or instances of the field specified by XPath .
Syntax
int GetXCount();
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.
Data Type
Integer
XPath Property (GRPC Class)
This property provides a way to point to a specific field in the message.
Syntax
QString GetXPath();
int SetXPath(QString qsXPath);
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:
- ReadBool
- ReadBytes
- ReadDouble
- ReadFieldNumber
- ReadFixed32
- ReadFixed64
- ReadFloat
- ReadInt32
- ReadInt64
- ReadString
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()));
}
Data Type
String
BeginReadMessage Method (GRPC Class)
This method begins reading a message.
Syntax
int 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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
BeginReadPacked Method (GRPC Class)
This method begins reading a repeated packed field.
Syntax
int BeginReadPacked(int iWireType);
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.
Error Handling
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
BeginWriteMessage Method (GRPC Class)
This method begins writing a new message.
Syntax
int 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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
BeginWritePacked Method (GRPC Class)
This method begins writing a new packed repeated field.
Syntax
int 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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
CalcAuthorization Method (GRPC Class)
Calculates the Authorization header based on provided credentials.
Syntax
int 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 where the Authorization value needs to be calculated prior to sending a request.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (GRPC Class)
Sets or retrieves a configuration setting.
Syntax
QString Config(const QString& qsConfigurationString);
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.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoEvents Method (GRPC Class)
Processes events from the internal message queue.
Syntax
int 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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
EndReadMessage Method (GRPC Class)
This method ends reading a message.
Syntax
int 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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
EndReadPacked Method (GRPC Class)
This method ends reading a packed repeated field.
Syntax
int 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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
EndWriteMessage Method (GRPC Class)
This method ends writing a message.
Syntax
int 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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
EndWritePacked Method (GRPC Class)
This method ends writing a packed repeated field.
Syntax
int 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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
HasXPath Method (GRPC Class)
This method determines whether a specific element exists in the document.
Syntax
bool HasXPath(const QString& qsXPath);
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.
Error Handling
This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Interrupt Method (GRPC Class)
Interrupt the current method.
Syntax
int Interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Post Method (GRPC Class)
This method posts a message to the HTTP server using the HTTP POST method.
Syntax
int Post(const QString& qsURL);
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)
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ReadBool Method (GRPC Class)
This method reads the Boolean value from the current field number and returns it.
Syntax
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.
Error Handling
This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ReadBytes Method (GRPC Class)
This method reads the value of type byte from the current field number and returns it.
Syntax
QByteArray 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.
Error Handling
This method returns a Binary String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ReadDouble Method (GRPC Class)
This method reads the value of type double from the current field number and returns it.
Syntax
QString 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.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ReadFieldNumber Method (GRPC Class)
This method reads the next field number and returns it.
Syntax
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.
Error Handling
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ReadFixed32 Method (GRPC Class)
This method reads the fixed int32 value from the current field number and returns it.
Syntax
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.
Error Handling
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ReadFixed64 Method (GRPC Class)
This method reads the fixed int64 value from the current field number and returns it.
Syntax
qint64 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.
Error Handling
This method returns a Long64 value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ReadFloat Method (GRPC Class)
This method reads the float value from the current field number and returns it.
Syntax
QString 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.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ReadInt32 Method (GRPC Class)
This method reads the int32 value from the current field number and returns it.
Syntax
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.
Error Handling
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ReadInt64 Method (GRPC Class)
This method reads the int64 value from the current field number and returns it.
Syntax
qint64 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.
Error Handling
This method returns a Long64 value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ReadSint32 Method (GRPC Class)
This method reads the sint32 value from the current field number and returns it.
Syntax
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.
Error Handling
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ReadSint64 Method (GRPC Class)
This method reads the sint64 value from the current field number and returns it.
Syntax
qint64 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.
Error Handling
This method returns a Long64 value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ReadSkip Method (GRPC Class)
This method skips reading a value from the current field.
Syntax
int 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();
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ReadString Method (GRPC Class)
This method reads the string value from the current field number and returns it.
Syntax
QString 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.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Reset Method (GRPC Class)
Reset the class.
Syntax
int Reset();
Remarks
This method will reset the class's properties to their default values.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
TryXPath Method (GRPC Class)
This method navigates to the specified XPath if it exists.
Syntax
bool TryXPath(const QString& qsxpath);
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.
Error Handling
This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
WriteBool Method (GRPC Class)
This method writes a Boolean value to the current field number.
Syntax
int WriteBool(bool bvalue);
Remarks
This method is used to write a Boolean value to the current field number. The current field number must be specified with WriteFieldNumber before calling this method.
The Boolean value must be passed to the value parameter.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
WriteBytes Method (GRPC Class)
This method writes a value of type byte to the current field number.
Syntax
int WriteBytes(QByteArray qbavalue);
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 WriteFieldNumber before calling this method.
The value of type byte must be passed to the value parameter.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
WriteDouble Method (GRPC Class)
This method writes a value of type double to the current field number.
Syntax
int WriteDouble(const QString& qsvalue);
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 WriteFieldNumber before calling this method.
The value of type double must be passed to the value parameter.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
WriteFieldNumber Method (GRPC Class)
This method specifies the field number to write.
Syntax
int WriteFieldNumber(int ivalue);
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.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
WriteFixed32 Method (GRPC Class)
This method writes a fixed32 value to the current field number.
Syntax
int WriteFixed32(int ivalue);
Remarks
This method is used to write a fixed32 value to the current field number. The current field number must be specified with WriteFieldNumber before calling this method.
The fixed32 value must be passed to the value parameter.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
WriteFixed64 Method (GRPC Class)
This method writes a fixed64 value to the current field number.
Syntax
int WriteFixed64(qint64 lvalue);
Remarks
This method is used to write a fixed64 value to the current field number. The current field number must be specified with WriteFieldNumber before calling this method.
The fixed64 value must be passed to the value parameter.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
WriteFloat Method (GRPC Class)
This method writes a float value to the current field number specified.
Syntax
int WriteFloat(const QString& qsvalue);
Remarks
This method is used to write a float value to the current field number. The current field number must be specified with WriteFieldNumber before calling this method.
The float value must be passed to the value parameter.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
WriteInt32 Method (GRPC Class)
This method writes an int32 value to the current field number.
Syntax
int WriteInt32(int ivalue);
Remarks
This method is used to write an int32 value to the current field number. The current field number must be specified with WriteFieldNumber before calling this method.
The int32 value must be passed to the value parameter.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
WriteInt64 Method (GRPC Class)
This method writes an int64 value to the current field number.
Syntax
int WriteInt64(qint64 lvalue);
Remarks
This method is used to write an int64 value to the current field number. The current field number must be specified with WriteFieldNumber before calling this method.
The int64 value must be passed to the value parameter.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
WriteSint32 Method (GRPC Class)
This method writes an sint32 value to the current field number.
Syntax
int WriteSint32(int ivalue);
Remarks
This method is used to write an sint32 value to the current field number. The current field number must be specified with WriteFieldNumber before calling this method.
The sint32 value must be passed to the value parameter.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
WriteSint64 Method (GRPC Class)
This method writes an sint64 value to the current field number.
Syntax
int WriteSint64(qint64 lvalue);
Remarks
This method is used to write an sint64 value to the current field number. The current field number must be specified with WriteFieldNumber before calling this method.
The sint364 value must be passed to the value parameter.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
WriteString Method (GRPC Class)
This method writes a string value to the current field number.
Syntax
int WriteString(const QString& qsvalue);
Remarks
This method is used to write a string value to the current field number. The current field number must be specified with WriteFieldNumber before calling this method.
The string value must be passed to the value parameter.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Connected Event (GRPC Class)
Fired immediately after a connection completes (or fails).
Syntax
class GRPCConnectedEventParams { public: int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Connected(GRPCConnectedEventParams *e);
// Or, subclass GRPC and override this emitter function. virtual int FireConnected(GRPCConnectedEventParams *e) {...}
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 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 Class)
Fired to indicate changes in connection state.
Syntax
class GRPCConnectionStatusEventParams { public: const QString &ConnectionEvent(); int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ConnectionStatus(GRPCConnectionStatusEventParams *e);
// Or, subclass GRPC and override this emitter function. virtual int FireConnectionStatus(GRPCConnectionStatusEventParams *e) {...}
Remarks
The ConnectionStatus event is fired when the connection state changes: completion of a firewall or proxy connection, completion of a security handshake, etc.
The ConnectionEvent parameter indicates the type of connection event. Values may include:
Firewall connection complete. | |
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 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 Class)
Fired when a connection is closed.
Syntax
class GRPCDisconnectedEventParams { public: int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Disconnected(GRPCDisconnectedEventParams *e);
// Or, subclass GRPC and override this emitter function. virtual int FireDisconnected(GRPCDisconnectedEventParams *e) {...}
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 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 Class)
Fired when a document finishes transferring.
Syntax
class GRPCEndTransferEventParams { public: int Direction(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void EndTransfer(GRPCEndTransferEventParams *e);
// Or, subclass GRPC and override this emitter function. virtual int FireEndTransfer(GRPCEndTransferEventParams *e) {...}
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 Class)
Information about errors during data delivery.
Syntax
class GRPCErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(GRPCErrorEventParams *e);
// Or, subclass GRPC and override this emitter function. virtual int FireError(GRPCErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
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 Class)
Fires once for each log message.
Syntax
class GRPCLogEventParams { public: int LogLevel(); const QString &Message(); const QString &LogType(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Log(GRPCLogEventParams *e);
// Or, subclass GRPC and override this emitter function. virtual int FireLog(GRPCLogEventParams *e) {...}
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:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data is logged. |
3 (Debug) | Debug data is 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:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
MessageIn Event (GRPC Class)
This event fires when a message response is sent by the server.
Syntax
class GRPCMessageInEventParams { public: bool Compressed(); int MessageLength(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void MessageIn(GRPCMessageInEventParams *e);
// Or, subclass GRPC and override this emitter function. virtual int FireMessageIn(GRPCMessageInEventParams *e) {...}
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 Class)
Fired when a redirection is received from the server.
Syntax
class GRPCRedirectEventParams { public: const QString &Location(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Redirect(GRPCRedirectEventParams *e);
// Or, subclass GRPC and override this emitter function. virtual int FireRedirect(GRPCRedirectEventParams *e) {...}
Remarks
This event is where the client can decide whether to continue with the redirection process or not. 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 fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.
SSLServerAuthentication Event (GRPC Class)
Fired after the server presents its certificate to the client.
Syntax
class GRPCSSLServerAuthenticationEventParams { public: const QByteArray &CertEncoded(); const QString &CertSubject(); const QString &CertIssuer(); const QString &Status(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLServerAuthentication(GRPCSSLServerAuthenticationEventParams *e);
// Or, subclass GRPC and override this emitter function. virtual int FireSSLServerAuthentication(GRPCSSLServerAuthenticationEventParams *e) {...}
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 Class)
Shows the progress of the secure connection.
Syntax
class GRPCSSLStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(GRPCSSLStatusEventParams *e);
// Or, subclass GRPC and override this emitter function. virtual int FireSSLStatus(GRPCSSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
StartTransfer Event (GRPC Class)
Fired when a document starts transferring (after the headers).
Syntax
class GRPCStartTransferEventParams { public: int Direction(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void StartTransfer(GRPCStartTransferEventParams *e);
// Or, subclass GRPC and override this emitter function. virtual int FireStartTransfer(GRPCStartTransferEventParams *e) {...}
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 Class)
Fired when the HTTP status line is received from the server.
Syntax
class GRPCStatusEventParams { public: const QString &HTTPVersion(); int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Status(GRPCStatusEventParams *e);
// Or, subclass GRPC and override this emitter function. virtual int FireStatus(GRPCStatusEventParams *e) {...}
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 Class)
Fired while a document transfers (delivers document).
Syntax
class GRPCTransferEventParams { public: int Direction(); qint64 BytesTransferred(); int PercentDone(); const QByteArray &Text(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Transfer(GRPCTransferEventParams *e);
// Or, subclass GRPC and override this emitter function. virtual int FireTransfer(GRPCTransferEventParams *e) {...}
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data is 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 that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.
Configuration Settings (GRPC Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.GRPC Configuration 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 Configuration 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 config 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 setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It will then 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 config. 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 setting controls whether HTTP/2 connections are permitted to fallback to HTTP/1.1 when the server does not support HTTP/2. This setting is only applicable 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 fails with an error if the server does not support HTTP/2. The default value is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Append:
Whether to append data to LocalFile. This setting determines whether data is 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 only applicable 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 non-empty 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. Returns the raw number of bytes from the HTTP response data, prior to the component processing the data, whether it is chunked and/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 only applicable 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 fails with an error. Note that 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 could potentially change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server and port are different than 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 fails with an error instead. Valid options are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 via 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:
When using HTTP/2 ("2.0") additional restrictions apply. Please see notes below for details.
HTTP/2 NotesWhen using HTTP/2 a secure (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 in order 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 NotesHTTP/3 is only supported in .NET & 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 non-empty 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. An example is:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 that not all server support persistent connections. You may also 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 setting controls the level of detail that is logged through the Log event. Possible values are:
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 besides 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 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" the class will fallback to using "1.1" automatically. This setting will indicate which was used. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OtherHeaders:
Other headers as determined by the user (optional). This configuration option can be set to a string of headers to be appended to the HTTP request headers. The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") . Use this configuration option with caution. If this configuration option contains invalid headers, HTTP requests may fail. This configuration option is useful for extending the functionality of the class beyond what is provided. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyAuthorization:
The authorization string to be sent to the proxy server. Similar to the Authorization config, but for proxy authorization. If this config contains a non-empty 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 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 setting is provided for use by classs that do not directly expose Proxy properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyPort:
Port for the proxy server (default 80). This 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 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 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 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 config to ON before making a request to enable it. Examples are below.
.NET
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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. 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. In the C++ Edition for Windows the *W version of the class must be used. For instance DNSW or HTTPW. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IPPort Configuration 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 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 fails with an error. NOTE: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallPort:
The TCP port for the FirewallHost;. Note that the FirewallPort is set automatically when FirewallType is set to a valid value. NOTE: This 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:
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 fails with an error. 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 acknowledgement is received from the remote host the keep-alive packet will be re-sent. This 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 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), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires. In the second scenario, 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 is 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 (by a client acknowledgment, for example), 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, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol 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 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 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSL Configuration 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 fails with an error. 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=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:
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
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:
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 true by default, but can be set to false 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. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipherStrength:
Returns the negotiated ciphersuite strength. Returns the strength of the ciphersuite negotiated during the SSL handshake. Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipherSuite:
Returns the negotiated ciphersuite. Returns the ciphersuite negotiated during the SSL handshake represented as a single string. Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedKeyExchange:
Returns the negotiated key exchange algorithm. Returns the key exchange algorithm negotiated during the SSL handshake. Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedVersion:
Returns the negotiated protocol version. Returns the protocol version negotiated during the SSL handshake. Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
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 fails with an error. The format of this value is a comma separated list of hash-signature combinations. For instance:
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13SignatureAlgorithms:
The allowed certificate signature algorithms. This setting holds a comma separated list of allowed signature algorithms. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Socket Configuration 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 Configuration 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:
The following is a list of valid code page identifiers for Mac OS only:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 true tells the class to use the internal implementation instead of using the system's security API. |
Trappable Errors (GRPC Class)
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. |
The class may also return one of the following error codes, which are inherited from other classes.
IPPort 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 Cannot change 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). |