GRPC Class
Properties Methods Events Config 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 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 Transmission Control Protocol (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 a Secure Sockets Layer (SSL) for the connection to the proxy. |
ProxyUser | This property contains a username 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 | This property is 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 | This property specifies the the maximum amount 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 | This method 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 | This event is fired immediately after a connection completes (or fails). |
ConnectionStatus | This event is fired to indicate changes in the connection state. |
Disconnected | This event is fired when a connection is closed. |
EndTransfer | This event is fired when a document finishes transferring. |
Error | Fired when information is available about errors during data delivery. |
Log | This event fires once for each log message. |
MessageIn | This event fires when a message response is sent by the server. |
Redirect | This event is fired when a redirection is received from the server. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event is fired when a document starts transferring (after the headers). |
Status | This event is fired when the HTTP status line is received from the server. |
Transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
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. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
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. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
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. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
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 cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
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. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | 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
ANSI (Cross Platform) char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization); Unicode (Windows) LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);
char* ipworks_grpc_getauthorization(void* lpObj);
int ipworks_grpc_setauthorization(void* lpObj, const char* lpszAuthorization);
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
ANSI (Cross Platform) int GetConnected();
int SetConnected(int bConnected); Unicode (Windows) BOOL GetConnected();
INT SetConnected(BOOL bConnected);
int ipworks_grpc_getconnected(void* lpObj);
int ipworks_grpc_setconnected(void* lpObj, int bConnected);
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
ANSI (Cross Platform) int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect); Unicode (Windows) BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);
int ipworks_grpc_getfirewallautodetect(void* lpObj);
int ipworks_grpc_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
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
ANSI (Cross Platform) int GetFirewallType();
int SetFirewallType(int iFirewallType); Unicode (Windows) INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);
Possible Values
FW_NONE(0),
FW_TUNNEL(1),
FW_SOCKS4(2),
FW_SOCKS5(3),
FW_SOCKS4A(10)
int ipworks_grpc_getfirewalltype(void* lpObj);
int ipworks_grpc_setfirewalltype(void* lpObj, int iFirewallType);
int GetFirewallType();
int SetFirewallType(int iFirewallType);
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
ANSI (Cross Platform) char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost); Unicode (Windows) LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);
char* ipworks_grpc_getfirewallhost(void* lpObj);
int ipworks_grpc_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
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
ANSI (Cross Platform) char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword); Unicode (Windows) LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);
char* ipworks_grpc_getfirewallpassword(void* lpObj);
int ipworks_grpc_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
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
ANSI (Cross Platform) int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); Unicode (Windows) INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);
int ipworks_grpc_getfirewallport(void* lpObj);
int ipworks_grpc_setfirewallport(void* lpObj, int iFirewallPort);
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
ANSI (Cross Platform) char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser); Unicode (Windows) LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);
char* ipworks_grpc_getfirewalluser(void* lpObj);
int ipworks_grpc_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
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
ANSI (Cross Platform) int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects); Unicode (Windows) INT GetFollowRedirects();
INT SetFollowRedirects(INT iFollowRedirects);
Possible Values
FR_NEVER(0),
FR_ALWAYS(1),
FR_SAME_SCHEME(2)
int ipworks_grpc_getfollowredirects(void* lpObj);
int ipworks_grpc_setfollowredirects(void* lpObj, int iFollowRedirects);
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);
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
ANSI (Cross Platform) int GetGRPCTimeout();
int SetGRPCTimeout(int iGRPCTimeout); Unicode (Windows) INT GetGRPCTimeout();
INT SetGRPCTimeout(INT iGRPCTimeout);
int ipworks_grpc_getgrpctimeout(void* lpObj);
int ipworks_grpc_setgrpctimeout(void* lpObj, int iGRPCTimeout);
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
ANSI (Cross Platform) int GetIdle(); Unicode (Windows) BOOL GetIdle();
int ipworks_grpc_getidle(void* lpObj);
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
ANSI (Cross Platform) int GetMessageData(char* &lpMessageData, int &lenMessageData); Unicode (Windows) INT GetMessageData(LPSTR &lpMessageData, INT &lenMessageData);
int ipworks_grpc_getmessagedata(void* lpObj, char** lpMessageData, int* lenMessageData);
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
Binary String
OtherHeaders Property (GRPC Class)
This property includes other headers as determined by the user (optional).
Syntax
ANSI (Cross Platform) char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders); Unicode (Windows) LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);
char* ipworks_grpc_getotherheaders(void* lpObj);
int ipworks_grpc_setotherheaders(void* lpObj, const char* lpszOtherHeaders);
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
ANSI (Cross Platform) int GetParsedHeaderCount(); Unicode (Windows) INT GetParsedHeaderCount();
int ipworks_grpc_getparsedheadercount(void* lpObj);
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
ANSI (Cross Platform) char* GetParsedHeaderField(int iParsedHeaderIndex); Unicode (Windows) LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);
char* ipworks_grpc_getparsedheaderfield(void* lpObj, int parsedheaderindex);
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
ANSI (Cross Platform) char* GetParsedHeaderValue(int iParsedHeaderIndex); Unicode (Windows) LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);
char* ipworks_grpc_getparsedheadervalue(void* lpObj, int parsedheaderindex);
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
ANSI (Cross Platform) int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme); Unicode (Windows) 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)
int ipworks_grpc_getproxyauthscheme(void* lpObj);
int ipworks_grpc_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);
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 used only 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
ANSI (Cross Platform) int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect); Unicode (Windows) BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);
int ipworks_grpc_getproxyautodetect(void* lpObj);
int ipworks_grpc_setproxyautodetect(void* lpObj, int bProxyAutoDetect);
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
ANSI (Cross Platform) char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
char* ipworks_grpc_getproxypassword(void* lpObj);
int ipworks_grpc_setproxypassword(void* lpObj, const char* lpszProxyPassword);
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 Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
ANSI (Cross Platform) int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
int ipworks_grpc_getproxyport(void* lpObj);
int ipworks_grpc_setproxyport(void* lpObj, int iProxyPort);
int GetProxyPort();
int SetProxyPort(int iProxyPort);
Default Value
80
Remarks
This property contains the Transmission Control Protocol (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
ANSI (Cross Platform) char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer); Unicode (Windows) LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);
char* ipworks_grpc_getproxyserver(void* lpObj);
int ipworks_grpc_setproxyserver(void* lpObj, const char* lpszProxyServer);
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. 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 a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
ANSI (Cross Platform) int GetProxySSL();
int SetProxySSL(int iProxySSL); Unicode (Windows) INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);
Possible Values
PS_AUTOMATIC(0),
PS_ALWAYS(1),
PS_NEVER(2),
PS_TUNNEL(3)
int ipworks_grpc_getproxyssl(void* lpObj);
int ipworks_grpc_setproxyssl(void* lpObj, int iProxySSL);
int GetProxySSL();
int SetProxySSL(int iProxySSL);
Default Value
0
Remarks
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. |
psAlways (1) | The connection is always SSL enabled. |
psNever (2) | The connection is not SSL enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
Data Type
Integer
ProxyUser Property (GRPC Class)
This property contains a username if authentication is to be used for the proxy.
Syntax
ANSI (Cross Platform) char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser); Unicode (Windows) LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);
char* ipworks_grpc_getproxyuser(void* lpObj);
int ipworks_grpc_setproxyuser(void* lpObj, const char* lpszProxyUser);
QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);
Default Value
""
Remarks
This property contains a username if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties 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
ANSI (Cross Platform) int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded); Unicode (Windows) INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);
int ipworks_grpc_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_grpc_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
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
Binary String
SSLCertEncoded Property (GRPC Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
int ipworks_grpc_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_grpc_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
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
Binary String
SSLCertStore Property (GRPC Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
int ipworks_grpc_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_grpc_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
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 designations are 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., PKCS#12 certificate store).
Data Type
Binary String
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
ANSI (Cross Platform) char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* ipworks_grpc_getsslcertstorepassword(void* lpObj);
int ipworks_grpc_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
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
ANSI (Cross Platform) int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) 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_PKCS11(23),
CST_AUTO(99)
int ipworks_grpc_getsslcertstoretype(void* lpObj);
int ipworks_grpc_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);
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 (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 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:
|
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
ANSI (Cross Platform) char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
char* ipworks_grpc_getsslcertsubject(void* lpObj);
int ipworks_grpc_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
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 properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname 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
ANSI (Cross Platform) int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);
Possible Values
SSLP_AUTOMATIC(0),
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int ipworks_grpc_getsslprovider(void* lpObj);
int ipworks_grpc_setsslprovider(void* lpObj, int iSSLProvider);
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);
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. |
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
ANSI (Cross Platform) int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded); Unicode (Windows) INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);
int ipworks_grpc_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
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
Binary String
Status Property (GRPC Class)
This property includes the gRPC status code.
Syntax
ANSI (Cross Platform) char* GetStatus(); Unicode (Windows) LPWSTR GetStatus();
char* ipworks_grpc_getstatus(void* lpObj);
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
ANSI (Cross Platform) char* GetStatusDescription(); Unicode (Windows) LPWSTR GetStatusDescription();
char* ipworks_grpc_getstatusdescription(void* lpObj);
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)
This property is the first line of the last server response.
Syntax
ANSI (Cross Platform) char* GetStatusLine(); Unicode (Windows) LPWSTR GetStatusLine();
char* ipworks_grpc_getstatusline(void* lpObj);
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 follows: [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
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int ipworks_grpc_gettimeout(void* lpObj);
int ipworks_grpc_settimeout(void* lpObj, int iTimeout);
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
ANSI (Cross Platform) int GetTransferredData(char* &lpTransferredData, int &lenTransferredData); Unicode (Windows) INT GetTransferredData(LPSTR &lpTransferredData, INT &lenTransferredData);
int ipworks_grpc_gettransferreddata(void* lpObj, char** lpTransferredData, int* lenTransferredData);
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
Binary String
TransferredDataLimit Property (GRPC Class)
This property specifies the the maximum amount of data to be transferred.
Syntax
ANSI (Cross Platform) int64 GetTransferredDataLimit();
int SetTransferredDataLimit(int64 lTransferredDataLimit); Unicode (Windows) LONG64 GetTransferredDataLimit();
INT SetTransferredDataLimit(LONG64 lTransferredDataLimit);
int64 ipworks_grpc_gettransferreddatalimit(void* lpObj);
int ipworks_grpc_settransferreddatalimit(void* lpObj, int64 lTransferredDataLimit);
qint64 GetTransferredDataLimit();
int SetTransferredDataLimit(qint64 lTransferredDataLimit);
Default Value
0
Remarks
This property contains the maximum amount of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the TransferredData property.
Data Type
Long64
TransferredHeaders Property (GRPC Class)
This property includes the complete set of headers as received from the server.
Syntax
ANSI (Cross Platform) char* GetTransferredHeaders(); Unicode (Windows) LPWSTR GetTransferredHeaders();
char* ipworks_grpc_gettransferredheaders(void* lpObj);
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
ANSI (Cross Platform) char* GetURL();
int SetURL(const char* lpszURL); Unicode (Windows) LPWSTR GetURL();
INT SetURL(LPCWSTR lpszURL);
char* ipworks_grpc_geturl(void* lpObj);
int ipworks_grpc_seturl(void* lpObj, const char* lpszURL);
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
ANSI (Cross Platform) int GetXCount(); Unicode (Windows) INT GetXCount();
int ipworks_grpc_getxcount(void* lpObj);
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
ANSI (Cross Platform) char* GetXPath();
int SetXPath(const char* lpszXPath); Unicode (Windows) LPWSTR GetXPath();
INT SetXPath(LPCWSTR lpszXPath);
char* ipworks_grpc_getxpath(void* lpObj);
int ipworks_grpc_setxpath(void* lpObj, const char* lpszXPath);
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
ANSI (Cross Platform) int BeginReadMessage(); Unicode (Windows) INT BeginReadMessage();
int ipworks_grpc_beginreadmessage(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int BeginReadPacked(int iWireType); Unicode (Windows) INT BeginReadPacked(INT iWireType);
int ipworks_grpc_beginreadpacked(void* lpObj, int iWireType);
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.
Possible values of the WireType parameter are:
ID (Name) | Used For |
0 (VARINT) | int32, int64, uint64, sint32, sint64, bool, enum |
1 (I64) | fixed64, sfixed64, double |
2 (LEN) | string, bytes, embedded messages, packed repeated fields |
3 (SGROUP) | group start (deprecated) |
4 (EGROUP) | group end (deprecated) |
5 (I32) | fixed32, sfixed32, float |
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 (C++)
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
ANSI (Cross Platform) int BeginWriteMessage(); Unicode (Windows) INT BeginWriteMessage();
int ipworks_grpc_beginwritemessage(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int BeginWritePacked(); Unicode (Windows) INT BeginWritePacked();
int ipworks_grpc_beginwritepacked(void* lpObj);
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. Note that since only repeated fields of primitive numeric types can be packed, this method cannot be used to write repeated strings or other non-primitive repeated fields.
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 (C++)
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)
This method calculates the Authorization header based on provided credentials.
Syntax
ANSI (Cross Platform) int CalcAuthorization(); Unicode (Windows) INT CalcAuthorization();
int ipworks_grpc_calcauthorization(void* lpObj);
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 in which the Authorization value needs to be calculated before sending a request.
Error Handling (C++)
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
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworks_grpc_config(void* lpObj, const char* lpszConfigurationString);
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 (C++)
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
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int ipworks_grpc_doevents(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int EndReadMessage(); Unicode (Windows) INT EndReadMessage();
int ipworks_grpc_endreadmessage(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int EndReadPacked(); Unicode (Windows) INT EndReadPacked();
int ipworks_grpc_endreadpacked(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int EndWriteMessage(); Unicode (Windows) INT EndWriteMessage();
int ipworks_grpc_endwritemessage(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int EndWritePacked(); Unicode (Windows) INT EndWritePacked();
int ipworks_grpc_endwritepacked(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int HasXPath(const char* lpszXPath); Unicode (Windows) INT HasXPath(LPCWSTR lpszXPath);
int ipworks_grpc_hasxpath(void* lpObj, const char* lpszXPath);
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 (C++)
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
ANSI (Cross Platform) int Interrupt(); Unicode (Windows) INT Interrupt();
int ipworks_grpc_interrupt(void* lpObj);
int Interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Error Handling (C++)
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
ANSI (Cross Platform) int Post(const char* lpszURL); Unicode (Windows) INT Post(LPCWSTR lpszURL);
int ipworks_grpc_post(void* lpObj, const char* lpszURL);
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("http://grpc.myserver.net");
Error Handling (C++)
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
ANSI (Cross Platform) int ReadBool(); Unicode (Windows) INT ReadBool();
int ipworks_grpc_readbool(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) char* ReadBytes(int *lpSize = NULL); Unicode (Windows) LPSTR ReadBytes(LPINT lpSize = NULL);
char* ipworks_grpc_readbytes(void* lpObjint *lpSize);
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 (C++)
This method returns a Binary String value (with length lpSize); 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
ANSI (Cross Platform) char* ReadDouble(); Unicode (Windows) LPWSTR ReadDouble();
char* ipworks_grpc_readdouble(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int ReadFieldNumber(); Unicode (Windows) INT ReadFieldNumber();
int ipworks_grpc_readfieldnumber(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int ReadFixed32(); Unicode (Windows) INT ReadFixed32();
int ipworks_grpc_readfixed32(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int64 ReadFixed64(); Unicode (Windows) LONG64 ReadFixed64();
int64 ipworks_grpc_readfixed64(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) char* ReadFloat(); Unicode (Windows) LPWSTR ReadFloat();
char* ipworks_grpc_readfloat(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int ReadInt32(); Unicode (Windows) INT ReadInt32();
int ipworks_grpc_readint32(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int64 ReadInt64(); Unicode (Windows) LONG64 ReadInt64();
int64 ipworks_grpc_readint64(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int ReadSint32(); Unicode (Windows) INT ReadSint32();
int ipworks_grpc_readsint32(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int64 ReadSint64(); Unicode (Windows) LONG64 ReadSint64();
int64 ipworks_grpc_readsint64(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int ReadSkip(); Unicode (Windows) INT ReadSkip();
int ipworks_grpc_readskip(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) char* ReadString(); Unicode (Windows) LPWSTR ReadString();
char* ipworks_grpc_readstring(void* lpObj);
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 (C++)
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
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworks_grpc_reset(void* lpObj);
int Reset();
Remarks
This method will reset the class's properties to their default values.
Error Handling (C++)
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
ANSI (Cross Platform) int TryXPath(const char* lpszxpath); Unicode (Windows) INT TryXPath(LPCWSTR lpszxpath);
int ipworks_grpc_tryxpath(void* lpObj, const char* lpszxpath);
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 (C++)
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
ANSI (Cross Platform) int WriteBool(int bvalue); Unicode (Windows) INT WriteBool(BOOL bvalue);
int ipworks_grpc_writebool(void* lpObj, int bvalue);
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 the WriteFieldNumber method before calling this method.
The Boolean value must be passed to the value parameter.
Error Handling (C++)
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
ANSI (Cross Platform) int WriteBytes(const char* lpvalue, int lenvalue); Unicode (Windows) INT WriteBytes(LPCSTR lpvalue, INT lenvalue);
int ipworks_grpc_writebytes(void* lpObj, const char* lpvalue, int lenvalue);
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 the WriteFieldNumber method before calling this method.
The value of type byte must be passed to the value parameter.
Error Handling (C++)
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
ANSI (Cross Platform) int WriteDouble(const char* lpszvalue); Unicode (Windows) INT WriteDouble(LPCWSTR lpszvalue);
int ipworks_grpc_writedouble(void* lpObj, const char* lpszvalue);
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 the WriteFieldNumber method before calling this method.
The value of type double must be passed to the value parameter.
Error Handling (C++)
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
ANSI (Cross Platform) int WriteFieldNumber(int ivalue); Unicode (Windows) INT WriteFieldNumber(INT ivalue);
int ipworks_grpc_writefieldnumber(void* lpObj, int ivalue);
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 (C++)
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
ANSI (Cross Platform) int WriteFixed32(int ivalue); Unicode (Windows) INT WriteFixed32(INT ivalue);
int ipworks_grpc_writefixed32(void* lpObj, int ivalue);
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 the WriteFieldNumber method before calling this method.
The fixed32 value must be passed to the value parameter.
Error Handling (C++)
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
ANSI (Cross Platform) int WriteFixed64(int64 lvalue); Unicode (Windows) INT WriteFixed64(LONG64 lvalue);
int ipworks_grpc_writefixed64(void* lpObj, int64 lvalue);
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 the WriteFieldNumber method before calling this method.
The fixed64 value must be passed to the value parameter.
Error Handling (C++)
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
ANSI (Cross Platform) int WriteFloat(const char* lpszvalue); Unicode (Windows) INT WriteFloat(LPCWSTR lpszvalue);
int ipworks_grpc_writefloat(void* lpObj, const char* lpszvalue);
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 the WriteFieldNumber method before calling this method.
The float value must be passed to the value parameter.
Error Handling (C++)
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
ANSI (Cross Platform) int WriteInt32(int ivalue); Unicode (Windows) INT WriteInt32(INT ivalue);
int ipworks_grpc_writeint32(void* lpObj, int ivalue);
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 the WriteFieldNumber method before calling this method.
The int32 value must be passed to the value parameter.
Error Handling (C++)
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
ANSI (Cross Platform) int WriteInt64(int64 lvalue); Unicode (Windows) INT WriteInt64(LONG64 lvalue);
int ipworks_grpc_writeint64(void* lpObj, int64 lvalue);
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 the WriteFieldNumber method before calling this method.
The int64 value must be passed to the value parameter.
Error Handling (C++)
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
ANSI (Cross Platform) int WriteSint32(int ivalue); Unicode (Windows) INT WriteSint32(INT ivalue);
int ipworks_grpc_writesint32(void* lpObj, int ivalue);
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 the WriteFieldNumber method before calling this method.
The sint32 value must be passed to the value parameter.
Error Handling (C++)
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
ANSI (Cross Platform) int WriteSint64(int64 lvalue); Unicode (Windows) INT WriteSint64(LONG64 lvalue);
int ipworks_grpc_writesint64(void* lpObj, int64 lvalue);
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 the WriteFieldNumber method before calling this method.
The sint364 value must be passed to the value parameter.
Error Handling (C++)
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
ANSI (Cross Platform) int WriteString(const char* lpszvalue); Unicode (Windows) INT WriteString(LPCWSTR lpszvalue);
int ipworks_grpc_writestring(void* lpObj, const char* lpszvalue);
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 the WriteFieldNumber method before calling this method.
The string value must be passed to the value parameter.
Error Handling (C++)
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)
This event is fired immediately after a connection completes (or fails).
Syntax
ANSI (Cross Platform) virtual int FireConnected(GRPCConnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } GRPCConnectedEventParams;
Unicode (Windows) virtual INT FireConnected(GRPCConnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } GRPCConnectedEventParams;
#define EID_GRPC_CONNECTED 1 virtual INT IPWORKS_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);
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 Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.
Please refer to the Error Codes section for more information.
ConnectionStatus Event (GRPC Class)
This event is fired to indicate changes in the connection state.
Syntax
ANSI (Cross Platform) virtual int FireConnectionStatus(GRPCConnectionStatusEventParams *e);
typedef struct {
const char *ConnectionEvent;
int StatusCode;
const char *Description; int reserved; } GRPCConnectionStatusEventParams;
Unicode (Windows) virtual INT FireConnectionStatus(GRPCConnectionStatusEventParams *e);
typedef struct {
LPCWSTR ConnectionEvent;
INT StatusCode;
LPCWSTR Description; INT reserved; } GRPCConnectionStatusEventParams;
#define EID_GRPC_CONNECTIONSTATUS 2 virtual INT IPWORKS_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);
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: for example, completion of a firewall or proxy connection or completion of a security handshake.
The ConnectionEvent parameter indicates the type of connection event. Values may include the following:
Firewall connection complete. | |
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
Disconnected Event (GRPC Class)
This event is fired when a connection is closed.
Syntax
ANSI (Cross Platform) virtual int FireDisconnected(GRPCDisconnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } GRPCDisconnectedEventParams;
Unicode (Windows) virtual INT FireDisconnected(GRPCDisconnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } GRPCDisconnectedEventParams;
#define EID_GRPC_DISCONNECTED 3 virtual INT IPWORKS_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);
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 Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.
Please refer to the Error Codes section for more information.
EndTransfer Event (GRPC Class)
This event is fired when a document finishes transferring.
Syntax
ANSI (Cross Platform) virtual int FireEndTransfer(GRPCEndTransferEventParams *e);
typedef struct {
int Direction; int reserved; } GRPCEndTransferEventParams;
Unicode (Windows) virtual INT FireEndTransfer(GRPCEndTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } GRPCEndTransferEventParams;
#define EID_GRPC_ENDTRANSFER 4 virtual INT IPWORKS_CALL FireEndTransfer(INT &iDirection);
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)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(GRPCErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } GRPCErrorEventParams;
Unicode (Windows) virtual INT FireError(GRPCErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } GRPCErrorEventParams;
#define EID_GRPC_ERROR 5 virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
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.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Log Event (GRPC Class)
This event fires once for each log message.
Syntax
ANSI (Cross Platform) virtual int FireLog(GRPCLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } GRPCLogEventParams;
Unicode (Windows) virtual INT FireLog(GRPCLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } GRPCLogEventParams;
#define EID_GRPC_LOG 6 virtual INT IPWORKS_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
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 as follows:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
MessageIn Event (GRPC Class)
This event fires when a message response is sent by the server.
Syntax
ANSI (Cross Platform) virtual int FireMessageIn(GRPCMessageInEventParams *e);
typedef struct {
int Compressed;
int MessageLength; int reserved; } GRPCMessageInEventParams;
Unicode (Windows) virtual INT FireMessageIn(GRPCMessageInEventParams *e);
typedef struct {
BOOL Compressed;
INT MessageLength; INT reserved; } GRPCMessageInEventParams;
#define EID_GRPC_MESSAGEIN 7 virtual INT IPWORKS_CALL FireMessageIn(BOOL &bCompressed, INT &iMessageLength);
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)
This event is fired when a redirection is received from the server.
Syntax
ANSI (Cross Platform) virtual int FireRedirect(GRPCRedirectEventParams *e);
typedef struct {
const char *Location;
int Accept; int reserved; } GRPCRedirectEventParams;
Unicode (Windows) virtual INT FireRedirect(GRPCRedirectEventParams *e);
typedef struct {
LPCWSTR Location;
BOOL Accept; INT reserved; } GRPCRedirectEventParams;
#define EID_GRPC_REDIRECT 8 virtual INT IPWORKS_CALL FireRedirect(LPSTR &lpszLocation, BOOL &bAccept);
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 fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class 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
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(GRPCSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } GRPCSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(GRPCSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } GRPCSSLServerAuthenticationEventParams;
#define EID_GRPC_SSLSERVERAUTHENTICATION 9 virtual INT IPWORKS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
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
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (GRPC Class)
Fired when secure connection progress messages are available.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(GRPCSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } GRPCSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(GRPCSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } GRPCSSLStatusEventParams;
#define EID_GRPC_SSLSTATUS 10 virtual INT IPWORKS_CALL FireSSLStatus(LPSTR &lpszMessage);
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. This event tracks the progress of the connection.
StartTransfer Event (GRPC Class)
This event is fired when a document starts transferring (after the headers).
Syntax
ANSI (Cross Platform) virtual int FireStartTransfer(GRPCStartTransferEventParams *e);
typedef struct {
int Direction; int reserved; } GRPCStartTransferEventParams;
Unicode (Windows) virtual INT FireStartTransfer(GRPCStartTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } GRPCStartTransferEventParams;
#define EID_GRPC_STARTTRANSFER 11 virtual INT IPWORKS_CALL FireStartTransfer(INT &iDirection);
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)
This event is fired when the HTTP status line is received from the server.
Syntax
ANSI (Cross Platform) virtual int FireStatus(GRPCStatusEventParams *e);
typedef struct {
const char *HTTPVersion;
int StatusCode;
const char *Description; int reserved; } GRPCStatusEventParams;
Unicode (Windows) virtual INT FireStatus(GRPCStatusEventParams *e);
typedef struct {
LPCWSTR HTTPVersion;
INT StatusCode;
LPCWSTR Description; INT reserved; } GRPCStatusEventParams;
#define EID_GRPC_STATUS 12 virtual INT IPWORKS_CALL FireStatus(LPSTR &lpszHTTPVersion, INT &iStatusCode, LPSTR &lpszDescription);
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)
This event is fired while a document transfers (delivers document).
Syntax
ANSI (Cross Platform) virtual int FireTransfer(GRPCTransferEventParams *e);
typedef struct {
int Direction;
int64 BytesTransferred;
int PercentDone;
const char *Text; int lenText; int reserved; } GRPCTransferEventParams;
Unicode (Windows) virtual INT FireTransfer(GRPCTransferEventParams *e);
typedef struct {
INT Direction;
LONG64 BytesTransferred;
INT PercentDone;
LPCSTR Text; INT lenText; INT reserved; } GRPCTransferEventParams;
#define EID_GRPC_TRANSFER 13 virtual INT IPWORKS_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);
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 are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Config 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 Config Settings
HTTP Config Settings
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
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.
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]".
The default value is False.
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: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
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.
Note: This setting is applicable only to Mac/iOS editions.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
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.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
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).
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.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
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.
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.
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.
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".
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.
If set to true, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
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.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider) please be aware of the following notes:
- The platform provider is only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This setting is only applicable when SSLProvider is set to Internal.
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.
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.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown Certificate Authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown Certificate Authority revocation status. |
0x00000800 | Ignore unknown Root revocation status. |
0x00008000 | Allow test Root certificate. |
0x00004000 | Trust test Root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
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-----
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:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for UDP ports.
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.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (GRPC Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
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.
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the class is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
302 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |