Struct ipworks::GRPC

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworks::GRPC

Remarks

The GRPC struct 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 struct supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the on_ssl_server_authentication event allows you to check the server identity and other security attributes. The on_ssl_status event provides information about the SSL handshake. Additional SSL-related settings are also supported through the config method.

Reading a Message

The GRPC struct can be used to read an incoming message. To read an incoming message, listen to the on_message_in event. The on_message_in event will fire for each message response from the server. For each message response, the message_data 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 has_xpath method may be used to determine whether or not an xpath exists before setting navigating to the location. The try_xpath 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:

• read_bool
• read_bytes
• read_double
• read_field_number
• read_fixed32
• read_fixed64
• read_float
• read_int32
• read_int64
• read_string

The following are possible values for a field accessor:

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.

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 on_message_in event and the Read* methods to read the message fields sequentially.

To read a message sequentially, first call begin_read_message. Next, call read_field_number 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:

• read_string
• read_int32
• read_int64
• read_float
• read_fixed32
• read_fixed64
• read_double
• read_bytes
• read_bool

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 begin_read_packed. begin_read_packed returns the count of the repeated values. Call the read_int32 method to sequentially read each packed value. When done reading the packed repeated values, call end_read_packed.

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

Writing a Message

The GRPC struct 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 begin_write_message. Next, call write_field_number 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 end_write_message.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorks. Due to this, the GRPC struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of GRPC when you have finished using the instance.

Property List

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

Method List

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

Event List

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

Config Settings

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

authorization property (GRPC Struct)

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

Syntax

fn authorization(&self ) -> Result<String, IPWorksError> 
fn set_authorization(&self, value : &str) ->  Option<IPWorksError> 
fn set_authorization_ref(&self, value : &String) ->  Option<IPWorksError> 

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 Struct)

This property shows whether the struct is connected.

Syntax

fn connected(&self ) -> Result<bool, IPWorksError> 

Default Value

false

Remarks

This property indicates whether the struct is connected to the remote host.

This property is read-only.

Data Type

bool

firewall_auto_detect property (GRPC Struct)

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

Syntax

fn firewall_auto_detect(&self ) -> Result<bool, IPWorksError> 
fn set_firewall_auto_detect(&self, value : bool) ->  Option<IPWorksError> 

Default Value

false

Remarks

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

Data Type

bool

firewall_type property (GRPC Struct)

The type of firewall to connect through.

Syntax

fn firewall_type(&self ) -> Result<i32, IPWorksError> 
fn set_firewall_type(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

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

Data Type

i32

firewall_host property (GRPC Struct)

The name or IP address of the firewall (optional).

Syntax

fn firewall_host(&self ) -> Result<String, IPWorksError> 
fn set_firewall_host(&self, value : &str) ->  Option<IPWorksError> 
fn set_firewall_host_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host 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 struct fails with an error.

Data Type

String

firewall_password property (GRPC Struct)

A password if authentication is to be used when connecting through the firewall.

Syntax

fn firewall_password(&self ) -> Result<String, IPWorksError> 
fn set_firewall_password(&self, value : &str) ->  Option<IPWorksError> 
fn set_firewall_password_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

Data Type

String

firewall_port property (GRPC Struct)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

fn firewall_port(&self ) -> Result<i32, IPWorksError> 
fn set_firewall_port(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

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

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

Data Type

i32

firewall_user property (GRPC Struct)

A username if authentication is to be used when connecting through a firewall.

Syntax

fn firewall_user(&self ) -> Result<String, IPWorksError> 
fn set_firewall_user(&self, value : &str) ->  Option<IPWorksError> 
fn set_firewall_user_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the struct fails with an error.

Data Type

String

follow_redirects property (GRPC Struct)

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

Syntax

fn follow_redirects(&self ) -> Result<i32, IPWorksError> 
fn set_follow_redirects(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // Never
1   // Always
2   // SameScheme

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the struct 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 on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_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 struct fails with an error instead.

Data Type

i32

grpc_timeout property (GRPC Struct)

The gRPC timeout.

Syntax

fn grpc_timeout(&self ) -> Result<i32, IPWorksError> 
fn set_grpc_timeout(&self, value : i32) ->  Option<IPWorksError> 

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

i32

idle property (GRPC Struct)

The current status of the struct.

Syntax

fn idle(&self ) -> Result<bool, IPWorksError> 

Default Value

true

Remarks

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

This property is read-only.

Data Type

bool

message_data property (GRPC Struct)

This property contains the message in a raw format.

Syntax

fn message_data(&self ) -> Result<Vec<u8>, IPWorksError> 
fn set_message_data(&self, value : Vec<u8>) ->  Option<IPWorksError> 
fn set_message_data_ref(&self, value : &[u8]) ->  Option<IPWorksError> 

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.

Data Type

Vec

other_headers property (GRPC Struct)

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

Syntax

fn other_headers(&self ) -> Result<String, IPWorksError> 
fn set_other_headers(&self, value : &str) ->  Option<IPWorksError> 
fn set_other_headers_ref(&self, value : &String) ->  Option<IPWorksError> 

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 struct beyond what is provided.

Data Type

String

parsed_header_count property (GRPC Struct)

The number of records in the ParsedHeader arrays.

Syntax

fn parsed_header_count(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

Data Type

i32

parsed_header_field property (GRPC Struct)

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

Syntax

fn parsed_header_field(&self , ParsedHeaderIndex : i32) -> Result<String, IPWorksError> 

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.

Data Type

String

parsed_header_value property (GRPC Struct)

This property contains the header contents.

Syntax

fn parsed_header_value(&self , ParsedHeaderIndex : i32) -> Result<String, IPWorksError> 

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.

Data Type

String

proxy_auth_scheme property (GRPC Struct)

The type of authorization to perform when connecting to the proxy.

Syntax

fn proxy_auth_scheme(&self ) -> Result<i32, IPWorksError> 
fn set_proxy_auth_scheme(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // Basic
1   // Digest
2   // Proprietary
3   // None
4   // Ntlm
5   // Negotiate

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

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

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the struct will attempt basic authentication.

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

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

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

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

Data Type

i32

proxy_auto_detect property (GRPC Struct)

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

Syntax

fn proxy_auto_detect(&self ) -> Result<bool, IPWorksError> 
fn set_proxy_auto_detect(&self, value : bool) ->  Option<IPWorksError> 

Default Value

false

Remarks

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

Data Type

bool

proxy_password property (GRPC Struct)

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

Syntax

fn proxy_password(&self ) -> Result<String, IPWorksError> 
fn set_proxy_password(&self, value : &str) ->  Option<IPWorksError> 
fn set_proxy_password_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

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

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

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

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

Data Type

String

proxy_port property (GRPC Struct)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fn proxy_port(&self ) -> Result<i32, IPWorksError> 
fn set_proxy_port(&self, value : i32) ->  Option<IPWorksError> 

Default Value

80

Remarks

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

Data Type

i32

proxy_server property (GRPC Struct)

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

Syntax

fn proxy_server(&self ) -> Result<String, IPWorksError> 
fn set_proxy_server(&self, value : &str) ->  Option<IPWorksError> 
fn set_proxy_server_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

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

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

Data Type

String

proxy_ssl property (GRPC Struct)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fn proxy_ssl(&self ) -> Result<i32, IPWorksError> 
fn set_proxy_ssl(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // Automatic
1   // Always
2   // Never
3   // Tunnel

Default Value

0

Remarks

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

Data Type

i32

proxy_user property (GRPC Struct)

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

Syntax

fn proxy_user(&self ) -> Result<String, IPWorksError> 
fn set_proxy_user(&self, value : &str) ->  Option<IPWorksError> 
fn set_proxy_user_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

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

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

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

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

Data Type

String

ssl_accept_server_cert_effective_date property (GRPC Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_expiration_date property (GRPC Struct)

The date on which the certificate expires.

Syntax

fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_extended_key_usage property (GRPC Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint property (GRPC Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha1 property (GRPC Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha256 property (GRPC Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_issuer property (GRPC Struct)

The issuer of the certificate.

Syntax

fn ssl_accept_server_cert_issuer(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key property (GRPC Struct)

The private key of the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key_available property (GRPC Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, IPWorksError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

ssl_accept_server_cert_private_key_container property (GRPC Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key property (GRPC Struct)

The public key of the certificate.

Syntax

fn ssl_accept_server_cert_public_key(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_algorithm property (GRPC Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_length property (GRPC Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

ssl_accept_server_cert_serial_number property (GRPC Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_signature_algorithm property (GRPC Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_store property (GRPC Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksError> 
fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksError> 
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Vec

ssl_accept_server_cert_store_password property (GRPC Struct)

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

Syntax

fn ssl_accept_server_cert_store_password(&self ) -> Result<String, IPWorksError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<IPWorksError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksError> 

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

ssl_accept_server_cert_store_type property (GRPC Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, IPWorksError> 
fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (GRPC Struct)

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

Syntax

fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (GRPC Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha1 property (GRPC Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha256 property (GRPC Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage property (GRPC Struct)

The text description of UsageFlags .

Syntax

fn ssl_accept_server_cert_usage(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

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

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage_flags property (GRPC Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

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

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

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

This property is read-only.

Data Type

i32

ssl_accept_server_cert_version property (GRPC Struct)

The certificate's version number.

Syntax

fn ssl_accept_server_cert_version(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_subject property (GRPC Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_accept_server_cert_subject(&self ) -> Result<String, IPWorksError> 
fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<IPWorksError> 
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

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=example@email.com". Common fields and their meanings are as follows:

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

Data Type

String

ssl_accept_server_cert_encoded property (GRPC Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksError> 
fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksError> 
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

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

Data Type

Vec

ssl_cert_effective_date property (GRPC Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (GRPC Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (GRPC Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (GRPC Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (GRPC Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (GRPC Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_cert_issuer property (GRPC Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_private_key property (GRPC Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (GRPC Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, IPWorksError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (GRPC Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_public_key property (GRPC Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (GRPC Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (GRPC Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (GRPC Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (GRPC Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_store property (GRPC Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, IPWorksError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Vec

ssl_cert_store_password property (GRPC Struct)

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

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, IPWorksError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksError> 

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

ssl_cert_store_type property (GRPC Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, IPWorksError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

i32

ssl_cert_subject_alt_names property (GRPC Struct)

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

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (GRPC Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (GRPC Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (GRPC Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_usage property (GRPC Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

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

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

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

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (GRPC Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

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

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

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

This property is read-only.

Data Type

i32

ssl_cert_version property (GRPC Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_subject property (GRPC Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, IPWorksError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<IPWorksError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

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=example@email.com". Common fields and their meanings are as follows:

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

Data Type

String

ssl_cert_encoded property (GRPC Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

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

Data Type

Vec

ssl_provider property (GRPC Struct)

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

Syntax

fn ssl_provider(&self ) -> Result<i32, IPWorksError> 
fn set_ssl_provider(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // Automatic
1   // Platform
2   // Internal

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 struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

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

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

i32

ssl_server_cert_effective_date property (GRPC Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_server_cert_effective_date(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_expiration_date property (GRPC Struct)

The date on which the certificate expires.

Syntax

fn ssl_server_cert_expiration_date(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_extended_key_usage property (GRPC Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint property (GRPC Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha1 property (GRPC Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha256 property (GRPC Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_server_cert_issuer property (GRPC Struct)

The issuer of the certificate.

Syntax

fn ssl_server_cert_issuer(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_private_key property (GRPC Struct)

The private key of the certificate (if available).

Syntax

fn ssl_server_cert_private_key(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_server_cert_private_key_available property (GRPC Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_server_cert_private_key_available(&self ) -> Result<bool, IPWorksError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

ssl_server_cert_private_key_container property (GRPC Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_server_cert_private_key_container(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_public_key property (GRPC Struct)

The public key of the certificate.

Syntax

fn ssl_server_cert_public_key(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_public_key_algorithm property (GRPC Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_public_key_length property (GRPC Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_server_cert_public_key_length(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

ssl_server_cert_serial_number property (GRPC Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_server_cert_serial_number(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_signature_algorithm property (GRPC Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_store property (GRPC Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

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

This property is read-only.

Data Type

Vec

ssl_server_cert_store_password property (GRPC Struct)

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

Syntax

fn ssl_server_cert_store_password(&self ) -> Result<String, IPWorksError> 

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.

This property is read-only.

Data Type

String

ssl_server_cert_store_type property (GRPC Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_server_cert_store_type(&self ) -> Result<i32, IPWorksError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (GRPC Struct)

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

Syntax

fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (GRPC Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha1 property (GRPC Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha256 property (GRPC Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_usage property (GRPC Struct)

The text description of UsageFlags .

Syntax

fn ssl_server_cert_usage(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

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

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

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

This property is read-only.

Data Type

String

ssl_server_cert_usage_flags property (GRPC Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_server_cert_usage_flags(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

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

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

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

This property is read-only.

Data Type

i32

ssl_server_cert_version property (GRPC Struct)

The certificate's version number.

Syntax

fn ssl_server_cert_version(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_subject property (GRPC Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_server_cert_subject(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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=example@email.com". Common fields and their meanings are as follows:

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

This property is read-only.

Data Type

String

ssl_server_cert_encoded property (GRPC Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

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

This property is read-only.

Data Type

Vec

status property (GRPC Struct)

This property includes the gRPC status code.

Syntax

fn status(&self ) -> Result<String, IPWorksError> 

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

status_description property (GRPC Struct)

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

Syntax

fn status_description(&self ) -> Result<String, IPWorksError> 

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

status_line property (GRPC Struct)

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

Syntax

fn status_line(&self ) -> Result<String, IPWorksError> 

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 struct, the error string is the same as the status_line property.

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

This property is read-only.

Data Type

String

timeout property (GRPC Struct)

The timeout for the struct.

Syntax

fn timeout(&self ) -> Result<i32, IPWorksError> 
fn set_timeout(&self, value : i32) ->  Option<IPWorksError> 

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 struct will wait for the operation to complete before returning control.

The struct will use do_events 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 struct fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, 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

i32

transferred_data property (GRPC Struct)

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

Syntax

fn transferred_data(&self ) -> Result<Vec<u8>, IPWorksError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

Vec

transferred_data_limit property (GRPC Struct)

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

Syntax

fn transferred_data_limit(&self ) -> Result<i64, IPWorksError> 
fn set_transferred_data_limit(&self, value : i64) ->  Option<IPWorksError> 

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

Data Type

i64

transferred_headers property (GRPC Struct)

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

Syntax

fn transferred_headers(&self ) -> Result<String, IPWorksError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

url property (GRPC Struct)

This property includes the URL to post.

Syntax

fn url(&self ) -> Result<String, IPWorksError> 
fn set_url(&self, value : &str) ->  Option<IPWorksError> 
fn set_url_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

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

Data Type

String

xcount property (GRPC Struct)

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

Syntax

fn xcount(&self ) -> Result<i32, IPWorksError> 

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

i32

xpath property (GRPC Struct)

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

Syntax

fn xpath(&self ) -> Result<String, IPWorksError> 
fn set_xpath(&self, value : &str) ->  Option<IPWorksError> 
fn set_xpath_ref(&self, value : &String) ->  Option<IPWorksError> 

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 has_xpath method may be used to determine whether or not an xpath exists before setting navigating to the location. The try_xpath 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:

• read_bool
• read_bytes
• read_double
• read_field_number
• read_fixed32
• read_fixed64
• read_float
• read_int32
• read_int64
• read_string

The following are possible values for a field accessor:

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.

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

begin_read_message method (GRPC Struct)

This method begins reading a message.

Syntax

fn begin_read_message(&self) -> Result<(), IPWorksError>

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 begin_read_message. Next, call read_field_number 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:

• read_string
• read_int32
• read_int64
• read_float
• read_fixed32
• read_fixed64
• read_double
• read_bytes
• read_bool

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 begin_read_packed. begin_read_packed returns the count of the repeated values. Call the read_int32 method to sequentially read each packed value. When done reading the packed repeated values, call end_read_packed.

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

begin_read_packed method (GRPC Struct)

This method begins reading a repeated packed field.

Syntax

fn begin_read_packed(&self, wire_type : i32) ->  Result<i32, IPWorksError>

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 wire_type parameter. This method returns the number of elements of the packed repeated field.

Possible values of the wire_type parameter are:

To read a message sequentially, first call begin_read_message. Next, call read_field_number 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:

• read_string
• read_int32
• read_int64
• read_float
• read_fixed32
• read_fixed64
• read_double
• read_bytes
• read_bool

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 begin_read_packed. begin_read_packed returns the count of the repeated values. Call the read_int32 method to sequentially read each packed value. When done reading the packed repeated values, call end_read_packed.

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

begin_write_message method (GRPC Struct)

This method begins writing a new message.

Syntax

fn begin_write_message(&self) -> Result<(), IPWorksError>

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 begin_write_message. Next, call write_field_number 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 end_write_message.

begin_write_packed method (GRPC Struct)

This method begins writing a new packed repeated field.

Syntax

fn begin_write_packed(&self) -> Result<(), IPWorksError>

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 begin_write_message. Next, call write_field_number 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 end_write_message.

calc_authorization method (GRPC Struct)

This method calculates the Authorization header based on provided credentials.

Syntax

fn calc_authorization(&self) -> Result<(), IPWorksError>

Remarks

This method calculates the authorization value using the values provided in auth_scheme, user, and password.

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

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

config method (GRPC Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksError>

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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.

do_events method (GRPC Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksError>

Remarks

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

end_read_message method (GRPC Struct)

This method ends reading a message.

Syntax

fn end_read_message(&self) -> Result<(), IPWorksError>

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 begin_read_message method. Each call to begin_read_message must have a matching call to end_read_message.

To read a message sequentially, first call begin_read_message. Next, call read_field_number 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:

• read_string
• read_int32
• read_int64
• read_float
• read_fixed32
• read_fixed64
• read_double
• read_bytes
• read_bool

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 begin_read_packed. begin_read_packed returns the count of the repeated values. Call the read_int32 method to sequentially read each packed value. When done reading the packed repeated values, call end_read_packed.

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

end_read_packed method (GRPC Struct)

This method ends reading a packed repeated field.

Syntax

fn end_read_packed(&self) -> Result<(), IPWorksError>

Remarks

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

To read a message sequentially, first call begin_read_message. Next, call read_field_number 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:

• read_string
• read_int32
• read_int64
• read_float
• read_fixed32
• read_fixed64
• read_double
• read_bytes
• read_bool

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 begin_read_packed. begin_read_packed returns the count of the repeated values. Call the read_int32 method to sequentially read each packed value. When done reading the packed repeated values, call end_read_packed.

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

end_write_message method (GRPC Struct)

This method ends writing a message.

Syntax

fn end_write_message(&self) -> Result<(), IPWorksError>

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 begin_write_message method. Each call to begin_write_message must have a matching call to EndWriteMessage.

To write a message, first call begin_write_message. Next, call write_field_number 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 end_write_message.

end_write_packed method (GRPC Struct)

This method ends writing a packed repeated field.

Syntax

fn end_write_packed(&self) -> Result<(), IPWorksError>

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 begin_write_packed method. Each call to begin_write_packed must have a matching call to EndWritePacked.

To write a message, first call begin_write_message. Next, call write_field_number 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 end_write_message.

has_xpath method (GRPC Struct)

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

Syntax

fn has_xpath(&self, xpath : &str) ->  Result<bool, IPWorksError>

Remarks

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

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

See xpath for details on the XPath syntax.

interrupt method (GRPC Struct)

This method interrupts the current method.

Syntax

fn interrupt(&self) -> Result<(), IPWorksError>

Remarks

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

post method (GRPC Struct)

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

Syntax

fn post(&self, url : &str) -> Result<(), IPWorksError>

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 on_transfer event and will be available in the message_data property. The message response can be read with the component by using the on_message_in 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");

read_bool method (GRPC Struct)

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

Syntax

fn read_bool(&self) ->  Result<bool, IPWorksError>

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

The read_field_number method must be called before calling read_bool.

read_bytes method (GRPC Struct)

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

Syntax

fn read_bytes(&self) ->  Result<Vec<u8>, IPWorksError>

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

The read_field_number method must be called before calling read_bytes.

read_double method (GRPC Struct)

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

Syntax

fn read_double(&self) ->  Result<String, IPWorksError>

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

The read_field_number method must be called before calling read_double.

read_field_number method (GRPC Struct)

This method reads the next field number and returns it.

Syntax

fn read_field_number(&self) ->  Result<i32, IPWorksError>

Remarks

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

read_fixed32 method (GRPC Struct)

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

Syntax

fn read_fixed32(&self) ->  Result<i32, IPWorksError>

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

The read_field_number method must be called before calling read_fixed32.

read_fixed64 method (GRPC Struct)

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

Syntax

fn read_fixed64(&self) ->  Result<i64, IPWorksError>

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

The read_field_number method must be called before calling read_fixed64.

read_float method (GRPC Struct)

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

Syntax

fn read_float(&self) ->  Result<String, IPWorksError>

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

The read_field_number method must be called before calling read_float.

read_int32 method (GRPC Struct)

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

Syntax

fn read_int32(&self) ->  Result<i32, IPWorksError>

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

The read_field_number method must be called before calling read_int32.

read_int64 method (GRPC Struct)

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

Syntax

fn read_int64(&self) ->  Result<i64, IPWorksError>

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

The read_field_number method must be called before calling read_int64.

read_sint32 method (GRPC Struct)

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

Syntax

fn read_sint32(&self) ->  Result<i32, IPWorksError>

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

The read_field_number method must be called before calling read_int32.

read_sint64 method (GRPC Struct)

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

Syntax

fn read_sint64(&self) ->  Result<i64, IPWorksError>

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

The read_field_number method must be called before calling read_int32.

read_skip method (GRPC Struct)

This method skips reading a value from the current field.

Syntax

fn read_skip(&self) -> Result<(), IPWorksError>

Remarks

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

Example. Using read_skip 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();

read_string method (GRPC Struct)

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

Syntax

fn read_string(&self) ->  Result<String, IPWorksError>

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

The read_field_number method must be called before calling read_string.

reset method (GRPC Struct)

This method will reset the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksError>

Remarks

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

try_xpath method (GRPC Struct)

This method navigates to the specified XPath if it exists.

Syntax

fn try_xpath(&self, xpath : &str) ->  Result<bool, IPWorksError>

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.

write_bool method (GRPC Struct)

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

Syntax

fn write_bool(&self, value : bool) -> Result<(), IPWorksError>

Remarks

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

The Boolean value must be passed to the value parameter.

write_bytes method (GRPC Struct)

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

Syntax

fn write_bytes(&self, value : &[u8]) -> Result<(), IPWorksError>

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 write_field_number method before calling this method.

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

write_double method (GRPC Struct)

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

Syntax

fn write_double(&self, value : &str) -> Result<(), IPWorksError>

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 write_field_number method before calling this method.

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

write_field_number method (GRPC Struct)

This method specifies the field number to write.

Syntax

fn write_field_number(&self, value : i32) -> Result<(), IPWorksError>

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.

write_fixed32 method (GRPC Struct)

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

Syntax

fn write_fixed32(&self, value : i32) -> Result<(), IPWorksError>

Remarks

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

The fixed32 value must be passed to the value parameter.

write_fixed64 method (GRPC Struct)

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

Syntax

fn write_fixed64(&self, value : i64) -> Result<(), IPWorksError>

Remarks

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

The fixed64 value must be passed to the value parameter.

write_float method (GRPC Struct)

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

Syntax

fn write_float(&self, value : &str) -> Result<(), IPWorksError>

Remarks

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

The float value must be passed to the value parameter.

write_int32 method (GRPC Struct)

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

Syntax

fn write_int32(&self, value : i32) -> Result<(), IPWorksError>

Remarks

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

The int32 value must be passed to the value parameter.

write_int64 method (GRPC Struct)

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

Syntax

fn write_int64(&self, value : i64) -> Result<(), IPWorksError>

Remarks

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

The int64 value must be passed to the value parameter.

write_sint32 method (GRPC Struct)

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

Syntax

fn write_sint32(&self, value : i32) -> Result<(), IPWorksError>

Remarks

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

The sint32 value must be passed to the value parameter.

write_sint64 method (GRPC Struct)

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

Syntax

fn write_sint64(&self, value : i64) -> Result<(), IPWorksError>

Remarks

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

The sint364 value must be passed to the value parameter.

write_string method (GRPC Struct)

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

Syntax

fn write_string(&self, value : &str) -> Result<(), IPWorksError>

Remarks

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

The string value must be passed to the value parameter.

on_connected event (GRPC Struct)

Fired immediately after a connection completes (or fails).

Syntax

// GRPCConnectedEventArgs carries the GRPC Connected event's parameters.
pub struct GRPCConnectedEventArgs {
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// GRPCConnectedEvent defines the signature of the GRPC Connected event's handler function.
pub trait GRPCConnectedEvent {
  fn on_connected(&self, sender : GRPC, e : &mut GRPCConnectedEventArgs);
}

impl <'a> GRPC<'a> {
  pub fn on_connected(&self) -> &'a dyn GRPCConnectedEvent;
  pub fn set_on_connected(&mut self, value : &'a dyn GRPCConnectedEvent);
  ...
}

Remarks

If the connection is made normally, status_code is 0 and description is "OK".

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

Please refer to the Error Codes section for more information.

on_connection_status event (GRPC Struct)

Fired to indicate changes in the connection state.

Syntax

// GRPCConnectionStatusEventArgs carries the GRPC ConnectionStatus event's parameters.
pub struct GRPCConnectionStatusEventArgs {
  fn connection_event(&self) -> &String
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// GRPCConnectionStatusEvent defines the signature of the GRPC ConnectionStatus event's handler function.
pub trait GRPCConnectionStatusEvent {
  fn on_connection_status(&self, sender : GRPC, e : &mut GRPCConnectionStatusEventArgs);
}

impl <'a> GRPC<'a> {
  pub fn on_connection_status(&self) -> &'a dyn GRPCConnectionStatusEvent;
  pub fn set_on_connection_status(&mut self, value : &'a dyn GRPCConnectionStatusEvent);
  ...
}

Remarks

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

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

on_disconnected event (GRPC Struct)

Fired when a connection is closed.

Syntax

// GRPCDisconnectedEventArgs carries the GRPC Disconnected event's parameters.
pub struct GRPCDisconnectedEventArgs {
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// GRPCDisconnectedEvent defines the signature of the GRPC Disconnected event's handler function.
pub trait GRPCDisconnectedEvent {
  fn on_disconnected(&self, sender : GRPC, e : &mut GRPCDisconnectedEventArgs);
}

impl <'a> GRPC<'a> {
  pub fn on_disconnected(&self) -> &'a dyn GRPCDisconnectedEvent;
  pub fn set_on_disconnected(&mut self, value : &'a dyn GRPCDisconnectedEvent);
  ...
}

Remarks

If the connection is broken normally, status_code is 0 and description is "OK".

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

Please refer to the Error Codes section for more information.

on_end_transfer event (GRPC Struct)

Fired when a document finishes transferring.

Syntax

// GRPCEndTransferEventArgs carries the GRPC EndTransfer event's parameters.
pub struct GRPCEndTransferEventArgs {
  fn direction(&self) -> i32
}

// GRPCEndTransferEvent defines the signature of the GRPC EndTransfer event's handler function.
pub trait GRPCEndTransferEvent {
  fn on_end_transfer(&self, sender : GRPC, e : &mut GRPCEndTransferEventArgs);
}

impl <'a> GRPC<'a> {
  pub fn on_end_transfer(&self) -> &'a dyn GRPCEndTransferEvent;
  pub fn set_on_end_transfer(&mut self, value : &'a dyn GRPCEndTransferEvent);
  ...
}

Remarks

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

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

on_error event (GRPC Struct)

Fired when information is available about errors during data delivery.

Syntax

// GRPCErrorEventArgs carries the GRPC Error event's parameters.
pub struct GRPCErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// GRPCErrorEvent defines the signature of the GRPC Error event's handler function.
pub trait GRPCErrorEvent {
  fn on_error(&self, sender : GRPC, e : &mut GRPCErrorEventArgs);
}

impl <'a> GRPC<'a> {
  pub fn on_error(&self) -> &'a dyn GRPCErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn GRPCErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

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

on_log event (GRPC Struct)

Fired once for each log message.

Syntax

// GRPCLogEventArgs carries the GRPC Log event's parameters.
pub struct GRPCLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// GRPCLogEvent defines the signature of the GRPC Log event's handler function.
pub trait GRPCLogEvent {
  fn on_log(&self, sender : GRPC, e : &mut GRPCLogEventArgs);
}

impl <'a> GRPC<'a> {
  pub fn on_log(&self) -> &'a dyn GRPCLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn GRPCLogEvent);
  ...
}

Remarks

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

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

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.

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

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

on_message_in event (GRPC Struct)

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

Syntax

// GRPCMessageInEventArgs carries the GRPC MessageIn event's parameters.
pub struct GRPCMessageInEventArgs {
  fn compressed(&self) -> bool
  fn message_length(&self) -> i32
}

// GRPCMessageInEvent defines the signature of the GRPC MessageIn event's handler function.
pub trait GRPCMessageInEvent {
  fn on_message_in(&self, sender : GRPC, e : &mut GRPCMessageInEventArgs);
}

impl <'a> GRPC<'a> {
  pub fn on_message_in(&self) -> &'a dyn GRPCMessageInEvent;
  pub fn set_on_message_in(&mut self, value : &'a dyn GRPCMessageInEvent);
  ...
}

Remarks

This event fires for every message response sent by the server after calling post. Every time this event fires, the message_data 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 message_length.

on_redirect event (GRPC Struct)

Fired when a redirection is received from the server.

Syntax

// GRPCRedirectEventArgs carries the GRPC Redirect event's parameters.
pub struct GRPCRedirectEventArgs {
  fn location(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// GRPCRedirectEvent defines the signature of the GRPC Redirect event's handler function.
pub trait GRPCRedirectEvent {
  fn on_redirect(&self, sender : GRPC, e : &mut GRPCRedirectEventArgs);
}

impl <'a> GRPC<'a> {
  pub fn on_redirect(&self) -> &'a dyn GRPCRedirectEvent;
  pub fn set_on_redirect(&mut self, value : &'a dyn GRPCRedirectEvent);
  ...
}

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 struct fails with an error. location is the location to which the client is being redirected. Further control over redirection is provided in the follow_redirects property.

on_ssl_server_authentication event (GRPC Struct)

Fired after the server presents its certificate to the client.

Syntax

// GRPCSSLServerAuthenticationEventArgs carries the GRPC SSLServerAuthentication event's parameters.
pub struct GRPCSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// GRPCSSLServerAuthenticationEvent defines the signature of the GRPC SSLServerAuthentication event's handler function.
pub trait GRPCSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : GRPC, e : &mut GRPCSSLServerAuthenticationEventArgs);
}

impl <'a> GRPC<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn GRPCSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn GRPCSSLServerAuthenticationEvent);
  ...
}

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.

on_ssl_status event (GRPC Struct)

Fired when secure connection progress messages are available.

Syntax

// GRPCSSLStatusEventArgs carries the GRPC SSLStatus event's parameters.
pub struct GRPCSSLStatusEventArgs {
  fn message(&self) -> &String
}

// GRPCSSLStatusEvent defines the signature of the GRPC SSLStatus event's handler function.
pub trait GRPCSSLStatusEvent {
  fn on_ssl_status(&self, sender : GRPC, e : &mut GRPCSSLStatusEventArgs);
}

impl <'a> GRPC<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn GRPCSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn GRPCSSLStatusEvent);
  ...
}

Remarks

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

on_start_transfer event (GRPC Struct)

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

Syntax

// GRPCStartTransferEventArgs carries the GRPC StartTransfer event's parameters.
pub struct GRPCStartTransferEventArgs {
  fn direction(&self) -> i32
}

// GRPCStartTransferEvent defines the signature of the GRPC StartTransfer event's handler function.
pub trait GRPCStartTransferEvent {
  fn on_start_transfer(&self, sender : GRPC, e : &mut GRPCStartTransferEventArgs);
}

impl <'a> GRPC<'a> {
  pub fn on_start_transfer(&self) -> &'a dyn GRPCStartTransferEvent;
  pub fn set_on_start_transfer(&mut self, value : &'a dyn GRPCStartTransferEvent);
  ...
}

Remarks

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

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

on_status event (GRPC Struct)

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

Syntax

// GRPCStatusEventArgs carries the GRPC Status event's parameters.
pub struct GRPCStatusEventArgs {
  fn http_version(&self) -> &String
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// GRPCStatusEvent defines the signature of the GRPC Status event's handler function.
pub trait GRPCStatusEvent {
  fn on_status(&self, sender : GRPC, e : &mut GRPCStatusEventArgs);
}

impl <'a> GRPC<'a> {
  pub fn on_status(&self) -> &'a dyn GRPCStatusEvent;
  pub fn set_on_status(&mut self, value : &'a dyn GRPCStatusEvent);
  ...
}

Remarks

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

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

on_transfer event (GRPC Struct)

Fired while a document transfers (delivers document).

Syntax

// GRPCTransferEventArgs carries the GRPC Transfer event's parameters.
pub struct GRPCTransferEventArgs {
  fn direction(&self) -> i32
  fn bytes_transferred(&self) -> i64
  fn percent_done(&self) -> i32
  fn text(&self) -> &[u8]
}

// GRPCTransferEvent defines the signature of the GRPC Transfer event's handler function.
pub trait GRPCTransferEvent {
  fn on_transfer(&self, sender : GRPC, e : &mut GRPCTransferEventArgs);
}

impl <'a> GRPC<'a> {
  pub fn on_transfer(&self) -> &'a dyn GRPCTransferEvent;
  pub fn set_on_transfer(&mut self, value : &'a dyn GRPCTransferEvent);
  ...
}

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 bytes_transferred 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 Struct)

GRPC Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (GRPC Struct)

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors