GRPC Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.IPWorks.GRPC

Remarks

The GRPC component 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 component 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 component 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 component 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

Authorization Property (GRPC Component)

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

Syntax

• C#
• VB.NET

public string Authorization { get; set; }

Public Property Authorization As String

Default Value

""

Remarks

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

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

This property is provided whenever the server requires authorization.

Connected Property (GRPC Component)

This property shows whether the component is connected.

Syntax

• C#
• VB.NET

public bool Connected { get; }

Public ReadOnly Property Connected As Boolean

Default Value

False

Remarks

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

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

Firewall Property (GRPC Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

FollowRedirects Property (GRPC Component)

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

Syntax

• C#
• VB.NET

public GRPCFollowRedirects FollowRedirects { get; set; }

enum GRPCFollowRedirects {
  frNever,
  frAlways,
  frSameScheme
}

Public Property FollowRedirects As GrpcFollowRedirects

Enum GRPCFollowRedirects
  frNever
  frAlways
  frSameScheme
End Enum

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the component 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 component throws an exception instead.

GRPCTimeout Property (GRPC Component)

The gRPC timeout.

Syntax

• C#
• VB.NET

public int GRPCTimeout { get; set; }

Public Property GRPCTimeout As Integer

Default Value

0

Remarks

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

Idle Property (GRPC Component)

The current status of the component.

Syntax

• C#
• VB.NET

public bool Idle { get; }

Public ReadOnly Property Idle As Boolean

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.

MessageData Property (GRPC Component)

This property contains the message in a raw format.

Syntax

• C#
• VB.NET

public string MessageData { get; }
public byte[] MessageDataB { get; }

Public ReadOnly Property MessageData As String
Public ReadOnly Property MessageDataB As Byte()

Default Value

""

Remarks

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

This property is read-only.

OtherHeaders Property (GRPC Component)

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

Syntax

• C#
• VB.NET

public string OtherHeaders { get; set; }

Public Property OtherHeaders As String

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

This property is not available at design time.

ParsedHeaders Property (GRPC Component)

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

Syntax

• C#
• VB.NET

public HeaderList ParsedHeaders { get; }

Public ReadOnly Property ParsedHeaders As HeaderList

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This collection is indexed from 0 to count -1.

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

Proxy Property (GRPC Component)

A set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

SSLAcceptServerCert Property (GRPC Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (GRPC Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (GRPC Component)

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

Syntax

• C#
• VB.NET

public GRPCSSLProviders SSLProvider { get; set; }

enum GRPCSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As GrpcSSLProviders

Enum GRPCSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

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 component 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 component will select a provider depending on the current platform.

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

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (GRPC Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Status Property (GRPC Component)

This property includes the gRPC status code.

Syntax

• C#
• VB.NET

public string Status { get; }

Public ReadOnly Property Status As String

Default Value

""

Remarks

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

This property is read-only.

StatusDescription Property (GRPC Component)

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

Syntax

• C#
• VB.NET

public string StatusDescription { get; }

Public ReadOnly Property StatusDescription As String

Default Value

""

Remarks

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

This property is read-only.

StatusLine Property (GRPC Component)

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

Syntax

• C#
• VB.NET

public string StatusLine { get; }

Public ReadOnly Property StatusLine As String

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

Timeout Property (GRPC Component)

The timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

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

The component 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 component throws an exception.

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.

TransferredData Property (GRPC Component)

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

Syntax

• C#
• VB.NET

public string TransferredData { get; }
public byte[] TransferredDataB { get; }

Public ReadOnly Property TransferredData As String
Public ReadOnly Property TransferredDataB As Byte()

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.

TransferredDataLimit Property (GRPC Component)

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

Syntax

• C#
• VB.NET

public long TransferredDataLimit { get; set; }

Public Property TransferredDataLimit As Long

Default Value

0

Remarks

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

TransferredHeaders Property (GRPC Component)

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

Syntax

• C#
• VB.NET

public string TransferredHeaders { get; }

Public ReadOnly Property TransferredHeaders As String

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.

URL Property (GRPC Component)

This property includes the URL to post.

Syntax

• C#
• VB.NET

public string URL { get; set; }

Public Property URL As String

Default Value

""

Remarks

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

XCount Property (GRPC Component)

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

Syntax

• C#
• VB.NET

public int XCount { get; }

Public ReadOnly Property XCount As Integer

Default Value

0

Remarks

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

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

This property is read-only.

XPath Property (GRPC Component)

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

Syntax

• C#
• VB.NET

public string XPath { get; set; }

Public Property XPath As String

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())); }

BeginReadMessage Method (GRPC Component)

This method begins reading a message.

Syntax

• C#
• VB.NET

public void BeginReadMessage();

Async Version
public async Task BeginReadMessage();
public async Task BeginReadMessage(CancellationToken cancellationToken);

Public Sub BeginReadMessage()

Async Version
Public Sub BeginReadMessage() As Task
Public Sub BeginReadMessage(cancellationToken As CancellationToken) As Task

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

This method begins reading a repeated packed field.

Syntax

• C#
• VB.NET

public int BeginReadPacked(int wireType);

Async Version
public async Task<int> BeginReadPacked(int wireType);
public async Task<int> BeginReadPacked(int wireType, CancellationToken cancellationToken);

Public Function BeginReadPacked(ByVal WireType As Integer) As Integer

Async Version
Public Function BeginReadPacked(ByVal WireType As Integer) As Task(Of Integer)
Public Function BeginReadPacked(ByVal WireType As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

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

This method begins writing a new message.

Syntax

• C#
• VB.NET

public void BeginWriteMessage();

Async Version
public async Task BeginWriteMessage();
public async Task BeginWriteMessage(CancellationToken cancellationToken);

Public Sub BeginWriteMessage()

Async Version
Public Sub BeginWriteMessage() As Task
Public Sub BeginWriteMessage(cancellationToken As CancellationToken) As Task

Remarks

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

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

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

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

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

As a last step, call EndWriteMessage.

BeginWritePacked Method (GRPC Component)

This method begins writing a new packed repeated field.

Syntax

• C#
• VB.NET

public void BeginWritePacked();

Async Version
public async Task BeginWritePacked();
public async Task BeginWritePacked(CancellationToken cancellationToken);

Public Sub BeginWritePacked()

Async Version
Public Sub BeginWritePacked() As Task
Public Sub BeginWritePacked(cancellationToken As CancellationToken) As Task

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

This method calculates the Authorization header based on provided credentials.

Syntax

• C#
• VB.NET

public void CalcAuthorization();

Async Version
public async Task CalcAuthorization();
public async Task CalcAuthorization(CancellationToken cancellationToken);

Public Sub CalcAuthorization()

Async Version
Public Sub CalcAuthorization() As Task
Public Sub CalcAuthorization(cancellationToken As CancellationToken) As Task

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 component will automatically calculate any required authorization values when a method is called, such as Get or Post.

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

Config Method (GRPC Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

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

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

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

DoEvents Method (GRPC Component)

This method processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

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

EndReadMessage Method (GRPC Component)

This method ends reading a message.

Syntax

• C#
• VB.NET

public void EndReadMessage();

Async Version
public async Task EndReadMessage();
public async Task EndReadMessage(CancellationToken cancellationToken);

Public Sub EndReadMessage()

Async Version
Public Sub EndReadMessage() As Task
Public Sub EndReadMessage(cancellationToken As CancellationToken) As Task

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

This method ends reading a packed repeated field.

Syntax

• C#
• VB.NET

public void EndReadPacked();

Async Version
public async Task EndReadPacked();
public async Task EndReadPacked(CancellationToken cancellationToken);

Public Sub EndReadPacked()

Async Version
Public Sub EndReadPacked() As Task
Public Sub EndReadPacked(cancellationToken As CancellationToken) As Task

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

This method ends writing a message.

Syntax

• C#
• VB.NET

public void EndWriteMessage();

Async Version
public async Task EndWriteMessage();
public async Task EndWriteMessage(CancellationToken cancellationToken);

Public Sub EndWriteMessage()

Async Version
Public Sub EndWriteMessage() As Task
Public Sub EndWriteMessage(cancellationToken As CancellationToken) As Task

Remarks

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

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

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

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

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

As a last step, call EndWriteMessage.

EndWritePacked Method (GRPC Component)

This method ends writing a packed repeated field.

Syntax

• C#
• VB.NET

public void EndWritePacked();

Async Version
public async Task EndWritePacked();
public async Task EndWritePacked(CancellationToken cancellationToken);

Public Sub EndWritePacked()

Async Version
Public Sub EndWritePacked() As Task
Public Sub EndWritePacked(cancellationToken As CancellationToken) As Task

Remarks

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

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

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

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

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

As a last step, call EndWriteMessage.

HasXPath Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public bool HasXPath(string XPath);

Async Version
public async Task<bool> HasXPath(string XPath);
public async Task<bool> HasXPath(string XPath, CancellationToken cancellationToken);

Public Function HasXPath(ByVal XPath As String) As Boolean

Async Version
Public Function HasXPath(ByVal XPath As String) As Task(Of Boolean)
Public Function HasXPath(ByVal XPath As String, cancellationToken As CancellationToken) As Task(Of Boolean)

Remarks

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

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

See XPath for details on the XPath syntax.

Interrupt Method (GRPC Component)

This method interrupts the current method.

Syntax

• C#
• VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

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

Post Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public void Post(string URL);

Async Version
public async Task Post(string URL);
public async Task Post(string URL, CancellationToken cancellationToken);

Public Sub Post(ByVal URL As String)

Async Version
Public Sub Post(ByVal URL As String) As Task
Public Sub Post(ByVal URL As String, cancellationToken As CancellationToken) As Task

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

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

Syntax

• C#
• VB.NET

public bool ReadBool();

Async Version
public async Task<bool> ReadBool();
public async Task<bool> ReadBool(CancellationToken cancellationToken);

Public Function ReadBool() As Boolean

Async Version
Public Function ReadBool() As Task(Of Boolean)
Public Function ReadBool(cancellationToken As CancellationToken) As Task(Of Boolean)

Remarks

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

The ReadFieldNumber method must be called before calling ReadBool.

ReadBytes Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public byte[] ReadBytes();

Async Version
public async Task<byte[]> ReadBytes();
public async Task<byte[]> ReadBytes(CancellationToken cancellationToken);

Public Function ReadBytes() As String

Async Version
Public Function ReadBytes() As Task(Of String)
Public Function ReadBytes(cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

The ReadFieldNumber method must be called before calling ReadBytes.

ReadDouble Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public string ReadDouble();

Async Version
public async Task<string> ReadDouble();
public async Task<string> ReadDouble(CancellationToken cancellationToken);

Public Function ReadDouble() As String

Async Version
Public Function ReadDouble() As Task(Of String)
Public Function ReadDouble(cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

The ReadFieldNumber method must be called before calling ReadDouble.

ReadFieldNumber Method (GRPC Component)

This method reads the next field number and returns it.

Syntax

• C#
• VB.NET

public int ReadFieldNumber();

Async Version
public async Task<int> ReadFieldNumber();
public async Task<int> ReadFieldNumber(CancellationToken cancellationToken);

Public Function ReadFieldNumber() As Integer

Async Version
Public Function ReadFieldNumber() As Task(Of Integer)
Public Function ReadFieldNumber(cancellationToken As CancellationToken) As Task(Of Integer)

Remarks

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

ReadFixed32 Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public int ReadFixed32();

Async Version
public async Task<int> ReadFixed32();
public async Task<int> ReadFixed32(CancellationToken cancellationToken);

Public Function ReadFixed32() As Integer

Async Version
Public Function ReadFixed32() As Task(Of Integer)
Public Function ReadFixed32(cancellationToken As CancellationToken) As Task(Of Integer)

Remarks

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

The ReadFieldNumber method must be called before calling ReadFixed32.

ReadFixed64 Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public long ReadFixed64();

Async Version
public async Task<long> ReadFixed64();
public async Task<long> ReadFixed64(CancellationToken cancellationToken);

Public Function ReadFixed64() As Long

Async Version
Public Function ReadFixed64() As Task(Of Long)
Public Function ReadFixed64(cancellationToken As CancellationToken) As Task(Of Long)

Remarks

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

The ReadFieldNumber method must be called before calling ReadFixed64.

ReadFloat Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public string ReadFloat();

Async Version
public async Task<string> ReadFloat();
public async Task<string> ReadFloat(CancellationToken cancellationToken);

Public Function ReadFloat() As String

Async Version
Public Function ReadFloat() As Task(Of String)
Public Function ReadFloat(cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

The ReadFieldNumber method must be called before calling ReadFloat.

ReadInt32 Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public int ReadInt32();

Async Version
public async Task<int> ReadInt32();
public async Task<int> ReadInt32(CancellationToken cancellationToken);

Public Function ReadInt32() As Integer

Async Version
Public Function ReadInt32() As Task(Of Integer)
Public Function ReadInt32(cancellationToken As CancellationToken) As Task(Of Integer)

Remarks

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

The ReadFieldNumber method must be called before calling ReadInt32.

ReadInt64 Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public long ReadInt64();

Async Version
public async Task<long> ReadInt64();
public async Task<long> ReadInt64(CancellationToken cancellationToken);

Public Function ReadInt64() As Long

Async Version
Public Function ReadInt64() As Task(Of Long)
Public Function ReadInt64(cancellationToken As CancellationToken) As Task(Of Long)

Remarks

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

The ReadFieldNumber method must be called before calling ReadInt64.

ReadSint32 Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public int ReadSint32();

Async Version
public async Task<int> ReadSint32();
public async Task<int> ReadSint32(CancellationToken cancellationToken);

Public Function ReadSint32() As Integer

Async Version
Public Function ReadSint32() As Task(Of Integer)
Public Function ReadSint32(cancellationToken As CancellationToken) As Task(Of Integer)

Remarks

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

The ReadFieldNumber method must be called before calling ReadInt32.

ReadSint64 Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public long ReadSint64();

Async Version
public async Task<long> ReadSint64();
public async Task<long> ReadSint64(CancellationToken cancellationToken);

Public Function ReadSint64() As Long

Async Version
Public Function ReadSint64() As Task(Of Long)
Public Function ReadSint64(cancellationToken As CancellationToken) As Task(Of Long)

Remarks

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

The ReadFieldNumber method must be called before calling ReadInt32.

ReadSkip Method (GRPC Component)

This method skips reading a value from the current field.

Syntax

• C#
• VB.NET

public void ReadSkip();

Async Version
public async Task ReadSkip();
public async Task ReadSkip(CancellationToken cancellationToken);

Public Sub ReadSkip()

Async Version
Public Sub ReadSkip() As Task
Public Sub ReadSkip(cancellationToken As CancellationToken) As Task

Remarks

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

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

ReadString Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public string ReadString();

Async Version
public async Task<string> ReadString();
public async Task<string> ReadString(CancellationToken cancellationToken);

Public Function ReadString() As String

Async Version
Public Function ReadString() As Task(Of String)
Public Function ReadString(cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

The ReadFieldNumber method must be called before calling ReadString.

Reset Method (GRPC Component)

This method will reset the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

TryXPath Method (GRPC Component)

This method navigates to the specified XPath if it exists.

Syntax

• C#
• VB.NET

public bool TryXPath(string xpath);

Async Version
public async Task<bool> TryXPath(string xpath);
public async Task<bool> TryXPath(string xpath, CancellationToken cancellationToken);

Public Function TryXPath(ByVal xpath As String) As Boolean

Async Version
Public Function TryXPath(ByVal xpath As String) As Task(Of Boolean)
Public Function TryXPath(ByVal xpath As String, cancellationToken As CancellationToken) As Task(Of Boolean)

Remarks

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

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

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

WriteBool Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public void WriteBool(bool value);

Async Version
public async Task WriteBool(bool value);
public async Task WriteBool(bool value, CancellationToken cancellationToken);

Public Sub WriteBool(ByVal value As Boolean)

Async Version
Public Sub WriteBool(ByVal value As Boolean) As Task
Public Sub WriteBool(ByVal value As Boolean, cancellationToken As CancellationToken) As Task

Remarks

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

The Boolean value must be passed to the value parameter.

WriteBytes Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public void WriteBytes(byte[] value);

Async Version
public async Task WriteBytes(byte[] value);
public async Task WriteBytes(byte[] value, CancellationToken cancellationToken);

Public Sub WriteBytes(ByVal value As String)

Async Version
Public Sub WriteBytes(ByVal value As String) As Task
Public Sub WriteBytes(ByVal value As String, cancellationToken As CancellationToken) As Task

Remarks

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

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

WriteDouble Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public void WriteDouble(string value);

Async Version
public async Task WriteDouble(string value);
public async Task WriteDouble(string value, CancellationToken cancellationToken);

Public Sub WriteDouble(ByVal value As String)

Async Version
Public Sub WriteDouble(ByVal value As String) As Task
Public Sub WriteDouble(ByVal value As String, cancellationToken As CancellationToken) As Task

Remarks

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

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

WriteFieldNumber Method (GRPC Component)

This method specifies the field number to write.

Syntax

• C#
• VB.NET

public void WriteFieldNumber(int value);

Async Version
public async Task WriteFieldNumber(int value);
public async Task WriteFieldNumber(int value, CancellationToken cancellationToken);

Public Sub WriteFieldNumber(ByVal value As Integer)

Async Version
Public Sub WriteFieldNumber(ByVal value As Integer) As Task
Public Sub WriteFieldNumber(ByVal value As Integer, cancellationToken As CancellationToken) As Task

Remarks

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

This method must be called before writing the field value.

WriteFixed32 Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public void WriteFixed32(int value);

Async Version
public async Task WriteFixed32(int value);
public async Task WriteFixed32(int value, CancellationToken cancellationToken);

Public Sub WriteFixed32(ByVal value As Integer)

Async Version
Public Sub WriteFixed32(ByVal value As Integer) As Task
Public Sub WriteFixed32(ByVal value As Integer, cancellationToken As CancellationToken) As Task

Remarks

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

The fixed32 value must be passed to the value parameter.

WriteFixed64 Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public void WriteFixed64(long value);

Async Version
public async Task WriteFixed64(long value);
public async Task WriteFixed64(long value, CancellationToken cancellationToken);

Public Sub WriteFixed64(ByVal value As Long)

Async Version
Public Sub WriteFixed64(ByVal value As Long) As Task
Public Sub WriteFixed64(ByVal value As Long, cancellationToken As CancellationToken) As Task

Remarks

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

The fixed64 value must be passed to the value parameter.

WriteFloat Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public void WriteFloat(string value);

Async Version
public async Task WriteFloat(string value);
public async Task WriteFloat(string value, CancellationToken cancellationToken);

Public Sub WriteFloat(ByVal value As String)

Async Version
Public Sub WriteFloat(ByVal value As String) As Task
Public Sub WriteFloat(ByVal value As String, cancellationToken As CancellationToken) As Task

Remarks

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

The float value must be passed to the value parameter.

WriteInt32 Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public void WriteInt32(int value);

Async Version
public async Task WriteInt32(int value);
public async Task WriteInt32(int value, CancellationToken cancellationToken);

Public Sub WriteInt32(ByVal value As Integer)

Async Version
Public Sub WriteInt32(ByVal value As Integer) As Task
Public Sub WriteInt32(ByVal value As Integer, cancellationToken As CancellationToken) As Task

Remarks

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

The int32 value must be passed to the value parameter.

WriteInt64 Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public void WriteInt64(long value);

Async Version
public async Task WriteInt64(long value);
public async Task WriteInt64(long value, CancellationToken cancellationToken);

Public Sub WriteInt64(ByVal value As Long)

Async Version
Public Sub WriteInt64(ByVal value As Long) As Task
Public Sub WriteInt64(ByVal value As Long, cancellationToken As CancellationToken) As Task

Remarks

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

The int64 value must be passed to the value parameter.

WriteSint32 Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public void WriteSint32(int value);

Async Version
public async Task WriteSint32(int value);
public async Task WriteSint32(int value, CancellationToken cancellationToken);

Public Sub WriteSint32(ByVal value As Integer)

Async Version
Public Sub WriteSint32(ByVal value As Integer) As Task
Public Sub WriteSint32(ByVal value As Integer, cancellationToken As CancellationToken) As Task

Remarks

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

The sint32 value must be passed to the value parameter.

WriteSint64 Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public void WriteSint64(long value);

Async Version
public async Task WriteSint64(long value);
public async Task WriteSint64(long value, CancellationToken cancellationToken);

Public Sub WriteSint64(ByVal value As Long)

Async Version
Public Sub WriteSint64(ByVal value As Long) As Task
Public Sub WriteSint64(ByVal value As Long, cancellationToken As CancellationToken) As Task

Remarks

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

The sint364 value must be passed to the value parameter.

WriteString Method (GRPC Component)

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

Syntax

• C#
• VB.NET

public void WriteString(string value);

Async Version
public async Task WriteString(string value);
public async Task WriteString(string value, CancellationToken cancellationToken);

Public Sub WriteString(ByVal value As String)

Async Version
Public Sub WriteString(ByVal value As String) As Task
Public Sub WriteString(ByVal value As String, cancellationToken As CancellationToken) As Task

Remarks

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

The string value must be passed to the value parameter.

Connected Event (GRPC Component)

Fired immediately after a connection completes (or fails).

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, GRPCConnectedEventArgs e);

public class GRPCConnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As GRPCConnectedEventArgs)

Public Class GRPCConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

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

Please refer to the Error Codes section for more information.

ConnectionStatus Event (GRPC Component)

Fired to indicate changes in the connection state.

Syntax

• C#
• VB.NET

public event OnConnectionStatusHandler OnConnectionStatus;

public delegate void OnConnectionStatusHandler(object sender, GRPCConnectionStatusEventArgs e);

public class GRPCConnectionStatusEventArgs : EventArgs {
  public string ConnectionEvent { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnectionStatus As OnConnectionStatusHandler

Public Delegate Sub OnConnectionStatusHandler(sender As Object, e As GRPCConnectionStatusEventArgs)

Public Class GRPCConnectionStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionEvent As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

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

Fired when a connection is closed.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, GRPCDisconnectedEventArgs e);

public class GRPCDisconnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As GRPCDisconnectedEventArgs)

Public Class GRPCDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

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

Please refer to the Error Codes section for more information.

EndTransfer Event (GRPC Component)

Fired when a document finishes transferring.

Syntax

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, GRPCEndTransferEventArgs e);

public class GRPCEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As GRPCEndTransferEventArgs)

Public Class GRPCEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

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

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, GRPCErrorEventArgs e);

public class GRPCErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As GRPCErrorEventArgs)

Public Class GRPCErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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

Log Event (GRPC Component)

Fired once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, GRPCLogEventArgs e);

public class GRPCLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As GRPCLogEventArgs)

Public Class GRPCLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

This event is fired once for each log message generated by the component. 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 (GRPC Component)

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

Syntax

• C#
• VB.NET

public event OnMessageInHandler OnMessageIn;

public delegate void OnMessageInHandler(object sender, GRPCMessageInEventArgs e);

public class GRPCMessageInEventArgs : EventArgs {
  public bool Compressed { get; }
  public int MessageLength { get; }
}

Public Event OnMessageIn As OnMessageInHandler

Public Delegate Sub OnMessageInHandler(sender As Object, e As GRPCMessageInEventArgs)

Public Class GRPCMessageInEventArgs Inherits EventArgs
  Public ReadOnly Property Compressed As Boolean
  Public ReadOnly Property MessageLength As Integer
End Class

Remarks

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

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

The length of the message is shown by MessageLength.

Redirect Event (GRPC Component)

Fired when a redirection is received from the server.

Syntax

• C#
• VB.NET

public event OnRedirectHandler OnRedirect;

public delegate void OnRedirectHandler(object sender, GRPCRedirectEventArgs e);

public class GRPCRedirectEventArgs : EventArgs {
  public string Location { get; }
  public bool Accept { get; set; }
}

Public Event OnRedirect As OnRedirectHandler

Public Delegate Sub OnRedirectHandler(sender As Object, e As GRPCRedirectEventArgs)

Public Class GRPCRedirectEventArgs Inherits EventArgs
  Public ReadOnly Property Location As String
  Public Property Accept As Boolean
End Class

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

SSLServerAuthentication Event (GRPC Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, GRPCSSLServerAuthenticationEventArgs e);

public class GRPCSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As GRPCSSLServerAuthenticationEventArgs)

Public Class GRPCSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

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

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

SSLStatus Event (GRPC Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, GRPCSSLStatusEventArgs e);

public class GRPCSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As GRPCSSLStatusEventArgs)

Public Class GRPCSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

StartTransfer Event (GRPC Component)

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

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, GRPCStartTransferEventArgs e);

public class GRPCStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As GRPCStartTransferEventArgs)

Public Class GRPCStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

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

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

Syntax

• C#
• VB.NET

public event OnStatusHandler OnStatus;

public delegate void OnStatusHandler(object sender, GRPCStatusEventArgs e);

public class GRPCStatusEventArgs : EventArgs {
  public string HTTPVersion { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnStatus As OnStatusHandler

Public Delegate Sub OnStatusHandler(sender As Object, e As GRPCStatusEventArgs)

Public Class GRPCStatusEventArgs Inherits EventArgs
  Public ReadOnly Property HTTPVersion As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

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

Transfer Event (GRPC Component)

Fired while a document transfers (delivers document).

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, GRPCTransferEventArgs e);

public class GRPCTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As GRPCTransferEventArgs)

Public Class GRPCTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

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.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

• C#
• VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

Firewall Type

The firewall the component will connect through.

Remarks

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

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

Header Type

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

Remarks

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

Fields

Constructors

• C#
• VB.NET

public Header();

Public Header()

• C#
• VB.NET

public Header(string field, string value);

Public Header(ByVal Field As String, ByVal Value As String)

Proxy Type

The proxy the component will connect to.

Remarks

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

Fields

Constructors

• C#
• VB.NET

public Proxy();

Public Proxy()

• C#
• VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

• C#
• VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

Config Settings (GRPC Component)

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