GRPC Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorks_GRPC

Procedural Interface

 ipworks_grpc_open();
 ipworks_grpc_close($res);
 ipworks_grpc_register_callback($res, $id, $function);
 ipworks_grpc_get_last_error($res);
 ipworks_grpc_get_last_error_code($res);
 ipworks_grpc_set($res, $id, $index, $value);
 ipworks_grpc_get($res, $id, $index);
 ipworks_grpc_do_beginreadmessage($res);
 ipworks_grpc_do_beginreadpacked($res, $wiretype);
 ipworks_grpc_do_beginwritemessage($res);
 ipworks_grpc_do_beginwritepacked($res);
 ipworks_grpc_do_calcauthorization($res);
 ipworks_grpc_do_config($res, $configurationstring);
 ipworks_grpc_do_doevents($res);
 ipworks_grpc_do_endreadmessage($res);
 ipworks_grpc_do_endreadpacked($res);
 ipworks_grpc_do_endwritemessage($res);
 ipworks_grpc_do_endwritepacked($res);
 ipworks_grpc_do_hasxpath($res, $xpath);
 ipworks_grpc_do_interrupt($res);
 ipworks_grpc_do_post($res, $url);
 ipworks_grpc_do_readbool($res);
 ipworks_grpc_do_readbytes($res);
 ipworks_grpc_do_readdouble($res);
 ipworks_grpc_do_readfieldnumber($res);
 ipworks_grpc_do_readfixed32($res);
 ipworks_grpc_do_readfixed64($res);
 ipworks_grpc_do_readfloat($res);
 ipworks_grpc_do_readint32($res);
 ipworks_grpc_do_readint64($res);
 ipworks_grpc_do_readsint32($res);
 ipworks_grpc_do_readsint64($res);
 ipworks_grpc_do_readskip($res);
 ipworks_grpc_do_readstring($res);
 ipworks_grpc_do_reset($res);
 ipworks_grpc_do_tryxpath($res, $xpath);
 ipworks_grpc_do_writebool($res, $value);
 ipworks_grpc_do_writebytes($res, $value);
 ipworks_grpc_do_writedouble($res, $value);
 ipworks_grpc_do_writefieldnumber($res, $value);
 ipworks_grpc_do_writefixed32($res, $value);
 ipworks_grpc_do_writefixed64($res, $value);
 ipworks_grpc_do_writefloat($res, $value);
 ipworks_grpc_do_writeint32($res, $value);
 ipworks_grpc_do_writeint64($res, $value);
 ipworks_grpc_do_writesint32($res, $value);
 ipworks_grpc_do_writesint64($res, $value);
 ipworks_grpc_do_writestring($res, $value);

Remarks

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

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

Reading a Message

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

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

XPath

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

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

• ReadBool
• ReadBytes
• ReadDouble
• ReadFieldNumber
• ReadFixed32
• ReadFixed64
• ReadFloat
• ReadInt32
• ReadInt64
• ReadString

The following are possible values for a field accessor:

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

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

• ReadString
• ReadInt32
• ReadInt64
• ReadFloat
• ReadFixed32
• ReadFixed64
• ReadDouble
• ReadBytes
• ReadBool

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

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

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

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

As a last step, call EndReadMessage.

Writing a Message

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

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

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

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

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

As a last step, call EndWriteMessage.

Property List

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

Method List

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

Event List

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

Config Settings

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

Authorization Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getAuthorization();
public function setAuthorization($value);

Procedural Interface

ipworks_grpc_get($res, 1 );
ipworks_grpc_set($res, 1, $value );

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 (IPWorks_GRPC Class)

This property shows whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworks_grpc_get($res, 2 );

Default Value

false

Remarks

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

This property is read-only and not available at design time.

Data Type

Boolean

FirewallAutoDetect Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworks_grpc_get($res, 3 );
ipworks_grpc_set($res, 3, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (IPWorks_GRPC Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworks_grpc_get($res, 4 );
ipworks_grpc_set($res, 4, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworks_grpc_get($res, 5 );
ipworks_grpc_set($res, 5, $value );

Default Value

''

Remarks

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

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

Data Type

String

FirewallPassword Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

ipworks_grpc_get($res, 6 );
ipworks_grpc_set($res, 6, $value );

Default Value

''

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworks_grpc_get($res, 7 );
ipworks_grpc_set($res, 7, $value );

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworks_grpc_get($res, 8 );
ipworks_grpc_set($res, 8, $value );

Default Value

''

Remarks

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

Data Type

String

FollowRedirects Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getFollowRedirects();
public function setFollowRedirects($value);

Procedural Interface

ipworks_grpc_get($res, 9 );
ipworks_grpc_set($res, 9, $value );

Default Value

0

Remarks

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

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

If the new URL server is different from the existing one, Authorization is also reset to empty, unless this property is set to frAlways (1), in which case the same credentials are used to connect to the new server.

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

The default value is frNever (0). In this case, redirects are never followed, and the class fails with an error instead.

Data Type

Integer

GRPCTimeout Property (IPWorks_GRPC Class)

The gRPC timeout.

Object Oriented Interface

public function getGRPCTimeout();
public function setGRPCTimeout($value);

Procedural Interface

ipworks_grpc_get($res, 10 );
ipworks_grpc_set($res, 10, $value );

Default Value

0

Remarks

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

Data Type

Integer

Idle Property (IPWorks_GRPC Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworks_grpc_get($res, 11 );

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

Boolean

MessageData Property (IPWorks_GRPC Class)

This property contains the message in a raw format.

Object Oriented Interface

public function getMessageData();

Procedural Interface

ipworks_grpc_get($res, 12 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

Binary String

OtherHeaders Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

ipworks_grpc_get($res, 13 );
ipworks_grpc_set($res, 13, $value );

Default Value

''

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

ParsedHeaderCount Property (IPWorks_GRPC Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

ipworks_grpc_get($res, 14 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

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

This property is read-only and not available at design time.

Data Type

Integer

ParsedHeaderField Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

ipworks_grpc_get($res, 15 , $parsedheaderindex);

Default Value

''

Remarks

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

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderValue Property (IPWorks_GRPC Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

ipworks_grpc_get($res, 16 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ProxyAuthScheme Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

ipworks_grpc_get($res, 17 );
ipworks_grpc_set($res, 17, $value );

Default Value

0

Remarks

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

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

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the class will attempt basic authentication.

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

ipworks_grpc_get($res, 18 );
ipworks_grpc_set($res, 18, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

ipworks_grpc_get($res, 19 );
ipworks_grpc_set($res, 19, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

ipworks_grpc_get($res, 20 );
ipworks_grpc_set($res, 20, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

ipworks_grpc_get($res, 21 );
ipworks_grpc_set($res, 21, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

ipworks_grpc_get($res, 22 );
ipworks_grpc_set($res, 22, $value );

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

Integer

ProxyUser Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

ipworks_grpc_get($res, 23 );
ipworks_grpc_set($res, 23, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

SSLAcceptServerCertEffectiveDate Property (IPWorks_GRPC Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworks_grpc_get($res, 24 );

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

SSLAcceptServerCertExpirationDate Property (IPWorks_GRPC Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworks_grpc_get($res, 25 );

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

SSLAcceptServerCertExtendedKeyUsage Property (IPWorks_GRPC Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworks_grpc_get($res, 26 );

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

SSLAcceptServerCertFingerprint Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworks_grpc_get($res, 27 );

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

SSLAcceptServerCertFingerprintSHA1 Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworks_grpc_get($res, 28 );

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

SSLAcceptServerCertFingerprintSHA256 Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworks_grpc_get($res, 29 );

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

SSLAcceptServerCertIssuer Property (IPWorks_GRPC Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworks_grpc_get($res, 30 );

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

SSLAcceptServerCertPrivateKey Property (IPWorks_GRPC Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworks_grpc_get($res, 31 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorks_GRPC Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworks_grpc_get($res, 32 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworks_grpc_get($res, 33 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorks_GRPC Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworks_grpc_get($res, 34 );

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

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworks_grpc_get($res, 35 );

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

SSLAcceptServerCertPublicKeyLength Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworks_grpc_get($res, 36 );

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

Integer

SSLAcceptServerCertSerialNumber Property (IPWorks_GRPC Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworks_grpc_get($res, 37 );

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

SSLAcceptServerCertSignatureAlgorithm Property (IPWorks_GRPC Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworks_grpc_get($res, 38 );

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

SSLAcceptServerCertStore Property (IPWorks_GRPC Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworks_grpc_get($res, 39 );
ipworks_grpc_set($res, 39, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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

Binary String

SSLAcceptServerCertStorePassword Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworks_grpc_get($res, 40 );
ipworks_grpc_set($res, 40, $value );

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

SSLAcceptServerCertStoreType Property (IPWorks_GRPC Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworks_grpc_get($res, 41 );
ipworks_grpc_set($res, 41, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworks_grpc_get($res, 42 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorks_GRPC Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworks_grpc_get($res, 43 );

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

SSLAcceptServerCertThumbprintSHA1 Property (IPWorks_GRPC Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworks_grpc_get($res, 44 );

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

SSLAcceptServerCertThumbprintSHA256 Property (IPWorks_GRPC Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworks_grpc_get($res, 45 );

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

SSLAcceptServerCertUsage Property (IPWorks_GRPC Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworks_grpc_get($res, 46 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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

SSLAcceptServerCertUsageFlags Property (IPWorks_GRPC Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworks_grpc_get($res, 47 );

Default Value

0

Remarks

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

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorks_GRPC Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworks_grpc_get($res, 48 );

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

SSLAcceptServerCertSubject Property (IPWorks_GRPC Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworks_grpc_get($res, 49 );
ipworks_grpc_set($res, 49, $value );

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorks_GRPC Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworks_grpc_get($res, 50 );
ipworks_grpc_set($res, 50, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (IPWorks_GRPC Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworks_grpc_get($res, 51 );

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

SSLCertExpirationDate Property (IPWorks_GRPC Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworks_grpc_get($res, 52 );

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

SSLCertExtendedKeyUsage Property (IPWorks_GRPC Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworks_grpc_get($res, 53 );

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

SSLCertFingerprint Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworks_grpc_get($res, 54 );

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

SSLCertFingerprintSHA1 Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworks_grpc_get($res, 55 );

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

SSLCertFingerprintSHA256 Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworks_grpc_get($res, 56 );

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

SSLCertIssuer Property (IPWorks_GRPC Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworks_grpc_get($res, 57 );

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

SSLCertPrivateKey Property (IPWorks_GRPC Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworks_grpc_get($res, 58 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorks_GRPC Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworks_grpc_get($res, 59 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworks_grpc_get($res, 60 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorks_GRPC Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworks_grpc_get($res, 61 );

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

SSLCertPublicKeyAlgorithm Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworks_grpc_get($res, 62 );

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

SSLCertPublicKeyLength Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworks_grpc_get($res, 63 );

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

Integer

SSLCertSerialNumber Property (IPWorks_GRPC Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworks_grpc_get($res, 64 );

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

SSLCertSignatureAlgorithm Property (IPWorks_GRPC Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworks_grpc_get($res, 65 );

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

SSLCertStore Property (IPWorks_GRPC Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworks_grpc_get($res, 66 );
ipworks_grpc_set($res, 66, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Binary String

SSLCertStorePassword Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworks_grpc_get($res, 67 );
ipworks_grpc_set($res, 67, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (IPWorks_GRPC Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworks_grpc_get($res, 68 );
ipworks_grpc_set($res, 68, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworks_grpc_get($res, 69 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorks_GRPC Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworks_grpc_get($res, 70 );

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

SSLCertThumbprintSHA1 Property (IPWorks_GRPC Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworks_grpc_get($res, 71 );

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

SSLCertThumbprintSHA256 Property (IPWorks_GRPC Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworks_grpc_get($res, 72 );

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

SSLCertUsage Property (IPWorks_GRPC Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworks_grpc_get($res, 73 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

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

SSLCertUsageFlags Property (IPWorks_GRPC Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworks_grpc_get($res, 74 );

Default Value

0

Remarks

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

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorks_GRPC Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworks_grpc_get($res, 75 );

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

SSLCertSubject Property (IPWorks_GRPC Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworks_grpc_get($res, 76 );
ipworks_grpc_set($res, 76, $value );

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

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

Data Type

String

SSLCertEncoded Property (IPWorks_GRPC Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworks_grpc_get($res, 77 );
ipworks_grpc_set($res, 77, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

ipworks_grpc_get($res, 78 );
ipworks_grpc_set($res, 78, $value );

Default Value

0

Remarks

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

Possible values are as follows:

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

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEffectiveDate Property (IPWorks_GRPC Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworks_grpc_get($res, 79 );

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

SSLServerCertExpirationDate Property (IPWorks_GRPC Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworks_grpc_get($res, 80 );

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

SSLServerCertExtendedKeyUsage Property (IPWorks_GRPC Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworks_grpc_get($res, 81 );

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

SSLServerCertFingerprint Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworks_grpc_get($res, 82 );

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

SSLServerCertFingerprintSHA1 Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworks_grpc_get($res, 83 );

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

SSLServerCertFingerprintSHA256 Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworks_grpc_get($res, 84 );

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

SSLServerCertIssuer Property (IPWorks_GRPC Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworks_grpc_get($res, 85 );

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

SSLServerCertPrivateKey Property (IPWorks_GRPC Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworks_grpc_get($res, 86 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorks_GRPC Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworks_grpc_get($res, 87 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworks_grpc_get($res, 88 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorks_GRPC Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworks_grpc_get($res, 89 );

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

SSLServerCertPublicKeyAlgorithm Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworks_grpc_get($res, 90 );

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

SSLServerCertPublicKeyLength Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworks_grpc_get($res, 91 );

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

Integer

SSLServerCertSerialNumber Property (IPWorks_GRPC Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworks_grpc_get($res, 92 );

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

SSLServerCertSignatureAlgorithm Property (IPWorks_GRPC Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworks_grpc_get($res, 93 );

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

SSLServerCertStore Property (IPWorks_GRPC Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworks_grpc_get($res, 94 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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

Binary String

SSLServerCertStorePassword Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

ipworks_grpc_get($res, 95 );

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

SSLServerCertStoreType Property (IPWorks_GRPC Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworks_grpc_get($res, 96 );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworks_grpc_get($res, 97 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorks_GRPC Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworks_grpc_get($res, 98 );

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

SSLServerCertThumbprintSHA1 Property (IPWorks_GRPC Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworks_grpc_get($res, 99 );

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

SSLServerCertThumbprintSHA256 Property (IPWorks_GRPC Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworks_grpc_get($res, 100 );

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

SSLServerCertUsage Property (IPWorks_GRPC Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworks_grpc_get($res, 101 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

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

SSLServerCertUsageFlags Property (IPWorks_GRPC Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworks_grpc_get($res, 102 );

Default Value

0

Remarks

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

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorks_GRPC Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworks_grpc_get($res, 103 );

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

SSLServerCertSubject Property (IPWorks_GRPC Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworks_grpc_get($res, 104 );

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=support@nsoftware.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

SSLServerCertEncoded Property (IPWorks_GRPC Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworks_grpc_get($res, 105 );

Default Value

''

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Binary String

Status Property (IPWorks_GRPC Class)

This property includes the gRPC status code.

Object Oriented Interface

public function getStatus();

Procedural Interface

ipworks_grpc_get($res, 106 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

StatusDescription Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getStatusDescription();

Procedural Interface

ipworks_grpc_get($res, 107 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

StatusLine Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getStatusLine();

Procedural Interface

ipworks_grpc_get($res, 108 );

Default Value

''

Remarks

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

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

This property is read-only and not available at design time.

Data Type

String

Timeout Property (IPWorks_GRPC Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworks_grpc_get($res, 109 );
ipworks_grpc_set($res, 109, $value );

Default Value

60

Remarks

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

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

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

If Timeout expires, and the operation is not yet complete, the class fails with an error.

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

Integer

TransferredData Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getTransferredData();

Procedural Interface

ipworks_grpc_get($res, 110 );

Default Value

''

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Binary String

TransferredDataLimit Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getTransferredDataLimit();
public function setTransferredDataLimit($value);

Procedural Interface

ipworks_grpc_get($res, 111 );
ipworks_grpc_set($res, 111, $value );

Default Value

0

Remarks

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

Data Type

Long64

TransferredHeaders Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getTransferredHeaders();

Procedural Interface

ipworks_grpc_get($res, 112 );

Default Value

''

Remarks

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

This property is read-only and not available at design time.

Data Type

String

URL Property (IPWorks_GRPC Class)

This property includes the URL to post.

Object Oriented Interface

public function getURL();
public function setURL($value);

Procedural Interface

ipworks_grpc_get($res, 113 );
ipworks_grpc_set($res, 113, $value );

Default Value

''

Remarks

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

Data Type

String

XCount Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getXCount();

Procedural Interface

ipworks_grpc_get($res, 114 );

Default Value

0

Remarks

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

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

This property is read-only.

Data Type

Integer

XPath Property (IPWorks_GRPC Class)

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

Object Oriented Interface

public function getXPath();
public function setXPath($value);

Procedural Interface

ipworks_grpc_get($res, 115 );
ipworks_grpc_set($res, 115, $value );

Default Value

''

Remarks

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

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

• ReadBool
• ReadBytes
• ReadDouble
• ReadFieldNumber
• ReadFixed32
• ReadFixed64
• ReadFloat
• ReadInt32
• ReadInt64
• ReadString

The following are possible values for a field accessor:

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

BeginReadMessage Method (IPWorks_GRPC Class)

This method begins reading a message.

Object Oriented Interface

public function doBeginReadMessage();

Procedural Interface

ipworks_grpc_do_beginreadmessage($res);

Remarks

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

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

• ReadString
• ReadInt32
• ReadInt64
• ReadFloat
• ReadFixed32
• ReadFixed64
• ReadDouble
• ReadBytes
• ReadBool

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

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

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

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

As a last step, call EndReadMessage.

BeginReadPacked Method (IPWorks_GRPC Class)

This method begins reading a repeated packed field.

Object Oriented Interface

public function doBeginReadPacked($wiretype);

Procedural Interface

ipworks_grpc_do_beginreadpacked($res, $wiretype);

Remarks

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

Possible values of the WireType parameter are:

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

• ReadString
• ReadInt32
• ReadInt64
• ReadFloat
• ReadFixed32
• ReadFixed64
• ReadDouble
• ReadBytes
• ReadBool

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

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

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

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

As a last step, call EndReadMessage.

BeginWriteMessage Method (IPWorks_GRPC Class)

This method begins writing a new message.

Object Oriented Interface

public function doBeginWriteMessage();

Procedural Interface

ipworks_grpc_do_beginwritemessage($res);

Remarks

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

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

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

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

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

As a last step, call EndWriteMessage.

BeginWritePacked Method (IPWorks_GRPC Class)

This method begins writing a new packed repeated field.

Object Oriented Interface

public function doBeginWritePacked();

Procedural Interface

ipworks_grpc_do_beginwritepacked($res);

Remarks

This method begins writing a new packed repeated field and always must be called before starting to write a new packed repeated field. Note that since only repeated fields of primitive numeric types can be packed, this method cannot be used to write repeated strings or other non-primitive repeated fields.

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

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

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

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

As a last step, call EndWriteMessage.

CalcAuthorization Method (IPWorks_GRPC Class)

This method calculates the Authorization header based on provided credentials.

Object Oriented Interface

public function doCalcAuthorization();

Procedural Interface

ipworks_grpc_do_calcauthorization($res);

Remarks

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

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

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

Config Method (IPWorks_GRPC Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_grpc_do_config($res, $configurationstring);

Remarks

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

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

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

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

DoEvents Method (IPWorks_GRPC Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworks_grpc_do_doevents($res);

Remarks

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

EndReadMessage Method (IPWorks_GRPC Class)

This method ends reading a message.

Object Oriented Interface

public function doEndReadMessage();

Procedural Interface

ipworks_grpc_do_endreadmessage($res);

Remarks

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

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

• ReadString
• ReadInt32
• ReadInt64
• ReadFloat
• ReadFixed32
• ReadFixed64
• ReadDouble
• ReadBytes
• ReadBool

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

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

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

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

As a last step, call EndReadMessage.

EndReadPacked Method (IPWorks_GRPC Class)

This method ends reading a packed repeated field.

Object Oriented Interface

public function doEndReadPacked();

Procedural Interface

ipworks_grpc_do_endreadpacked($res);

Remarks

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

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

• ReadString
• ReadInt32
• ReadInt64
• ReadFloat
• ReadFixed32
• ReadFixed64
• ReadDouble
• ReadBytes
• ReadBool

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

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

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

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

As a last step, call EndReadMessage.

EndWriteMessage Method (IPWorks_GRPC Class)

This method ends writing a message.

Object Oriented Interface

public function doEndWriteMessage();

Procedural Interface

ipworks_grpc_do_endwritemessage($res);

Remarks

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

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

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

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

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

As a last step, call EndWriteMessage.

EndWritePacked Method (IPWorks_GRPC Class)

This method ends writing a packed repeated field.

Object Oriented Interface

public function doEndWritePacked();

Procedural Interface

ipworks_grpc_do_endwritepacked($res);

Remarks

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

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

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

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

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

As a last step, call EndWriteMessage.

HasXPath Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doHasXPath($xpath);

Procedural Interface

ipworks_grpc_do_hasxpath($res, $xpath);

Remarks

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

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

See XPath for details on the XPath syntax.

Interrupt Method (IPWorks_GRPC Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworks_grpc_do_interrupt($res);

Remarks

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

Post Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doPost($url);

Procedural Interface

ipworks_grpc_do_post($res, $url);

Remarks

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

Example. Performing a post:

grpc.BeginWriteMessage(); grpc.WriteFieldNumber(1); grpc.WriteString("test"); grpc.WriteFieldNumber(2); grpc.WriteInt32(2); grpc.EndWriteMessage(); grpc.Post("http://grpc.myserver.net");

ReadBool Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doReadBool();

Procedural Interface

ipworks_grpc_do_readbool($res);

Remarks

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

The ReadFieldNumber method must be called before calling ReadBool.

ReadBytes Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doReadBytes();

Procedural Interface

ipworks_grpc_do_readbytes($res);

Remarks

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

The ReadFieldNumber method must be called before calling ReadBytes.

ReadDouble Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doReadDouble();

Procedural Interface

ipworks_grpc_do_readdouble($res);

Remarks

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

The ReadFieldNumber method must be called before calling ReadDouble.

ReadFieldNumber Method (IPWorks_GRPC Class)

This method reads the next field number and returns it.

Object Oriented Interface

public function doReadFieldNumber();

Procedural Interface

ipworks_grpc_do_readfieldnumber($res);

Remarks

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

ReadFixed32 Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doReadFixed32();

Procedural Interface

ipworks_grpc_do_readfixed32($res);

Remarks

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

The ReadFieldNumber method must be called before calling ReadFixed32.

ReadFixed64 Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doReadFixed64();

Procedural Interface

ipworks_grpc_do_readfixed64($res);

Remarks

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

The ReadFieldNumber method must be called before calling ReadFixed64.

ReadFloat Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doReadFloat();

Procedural Interface

ipworks_grpc_do_readfloat($res);

Remarks

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

The ReadFieldNumber method must be called before calling ReadFloat.

ReadInt32 Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doReadInt32();

Procedural Interface

ipworks_grpc_do_readint32($res);

Remarks

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

The ReadFieldNumber method must be called before calling ReadInt32.

ReadInt64 Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doReadInt64();

Procedural Interface

ipworks_grpc_do_readint64($res);

Remarks

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

The ReadFieldNumber method must be called before calling ReadInt64.

ReadSint32 Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doReadSint32();

Procedural Interface

ipworks_grpc_do_readsint32($res);

Remarks

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

The ReadFieldNumber method must be called before calling ReadInt32.

ReadSint64 Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doReadSint64();

Procedural Interface

ipworks_grpc_do_readsint64($res);

Remarks

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

The ReadFieldNumber method must be called before calling ReadInt32.

ReadSkip Method (IPWorks_GRPC Class)

This method skips reading a value from the current field.

Object Oriented Interface

public function doReadSkip();

Procedural Interface

ipworks_grpc_do_readskip($res);

Remarks

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

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

ReadString Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doReadString();

Procedural Interface

ipworks_grpc_do_readstring($res);

Remarks

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

The ReadFieldNumber method must be called before calling ReadString.

Reset Method (IPWorks_GRPC Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_grpc_do_reset($res);

Remarks

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

TryXPath Method (IPWorks_GRPC Class)

This method navigates to the specified XPath if it exists.

Object Oriented Interface

public function doTryXPath($xpath);

Procedural Interface

ipworks_grpc_do_tryxpath($res, $xpath);

Remarks

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

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

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

WriteBool Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doWriteBool($value);

Procedural Interface

ipworks_grpc_do_writebool($res, $value);

Remarks

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

The Boolean value must be passed to the value parameter.

WriteBytes Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doWriteBytes($value);

Procedural Interface

ipworks_grpc_do_writebytes($res, $value);

Remarks

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

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

WriteDouble Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doWriteDouble($value);

Procedural Interface

ipworks_grpc_do_writedouble($res, $value);

Remarks

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

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

WriteFieldNumber Method (IPWorks_GRPC Class)

This method specifies the field number to write.

Object Oriented Interface

public function doWriteFieldNumber($value);

Procedural Interface

ipworks_grpc_do_writefieldnumber($res, $value);

Remarks

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

This method must be called before writing the field value.

WriteFixed32 Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doWriteFixed32($value);

Procedural Interface

ipworks_grpc_do_writefixed32($res, $value);

Remarks

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

The fixed32 value must be passed to the value parameter.

WriteFixed64 Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doWriteFixed64($value);

Procedural Interface

ipworks_grpc_do_writefixed64($res, $value);

Remarks

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

The fixed64 value must be passed to the value parameter.

WriteFloat Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doWriteFloat($value);

Procedural Interface

ipworks_grpc_do_writefloat($res, $value);

Remarks

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

The float value must be passed to the value parameter.

WriteInt32 Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doWriteInt32($value);

Procedural Interface

ipworks_grpc_do_writeint32($res, $value);

Remarks

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

The int32 value must be passed to the value parameter.

WriteInt64 Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doWriteInt64($value);

Procedural Interface

ipworks_grpc_do_writeint64($res, $value);

Remarks

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

The int64 value must be passed to the value parameter.

WriteSint32 Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doWriteSint32($value);

Procedural Interface

ipworks_grpc_do_writesint32($res, $value);

Remarks

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

The sint32 value must be passed to the value parameter.

WriteSint64 Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doWriteSint64($value);

Procedural Interface

ipworks_grpc_do_writesint64($res, $value);

Remarks

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

The sint364 value must be passed to the value parameter.

WriteString Method (IPWorks_GRPC Class)

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

Object Oriented Interface

public function doWriteString($value);

Procedural Interface

ipworks_grpc_do_writestring($res, $value);

Remarks

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

The string value must be passed to the value parameter.

Connected Event (IPWorks_GRPC Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworks_grpc_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

Remarks

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

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

Please refer to the Error Codes section for more information.

ConnectionStatus Event (IPWorks_GRPC Class)

Fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworks_grpc_register_callback($res, 2, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

Remarks

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

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

Disconnected Event (IPWorks_GRPC Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworks_grpc_register_callback($res, 3, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 'description'

Remarks

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

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

Please refer to the Error Codes section for more information.

EndTransfer Event (IPWorks_GRPC Class)

Fired when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworks_grpc_register_callback($res, 4, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

Remarks

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

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

Error Event (IPWorks_GRPC Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_grpc_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

Log Event (IPWorks_GRPC Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworks_grpc_register_callback($res, 6, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

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

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

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

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

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

Message is the log entry.

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

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

MessageIn Event (IPWorks_GRPC Class)

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

Object Oriented Interface

public function fireMessageIn($param);

Procedural Interface

ipworks_grpc_register_callback($res, 7, array($this, 'fireMessageIn'));

Parameter List

 'compressed'
 'messagelength'

Remarks

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

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

The length of the message is shown by MessageLength.

Redirect Event (IPWorks_GRPC Class)

Fired when a redirection is received from the server.

Object Oriented Interface

public function fireRedirect($param);

Procedural Interface

ipworks_grpc_register_callback($res, 8, array($this, 'fireRedirect'));

Parameter List

 'location'
 'accept'

Remarks

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

SSLServerAuthentication Event (IPWorks_GRPC Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworks_grpc_register_callback($res, 9, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

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

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

SSLStatus Event (IPWorks_GRPC Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworks_grpc_register_callback($res, 10, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

StartTransfer Event (IPWorks_GRPC Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworks_grpc_register_callback($res, 11, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

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

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

Status Event (IPWorks_GRPC Class)

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

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

ipworks_grpc_register_callback($res, 12, array($this, 'fireStatus'));

Parameter List

 'httpversion'
 'statuscode'
 'description'

Remarks

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

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

Transfer Event (IPWorks_GRPC Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworks_grpc_register_callback($res, 13, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

Remarks

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

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

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

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

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

Config Settings (GRPC Class)

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

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