HttpClient

Creates a new instanse of the HttpClient class.

constructor

HttpClient()

Sub New()

Closes the currently open connection (if present).

method Abort

void Abort()

Sub Abort()

Gets or sets content types that are acceptable for the response. The default value is "text/html, image/gif, image/jpeg, image/png, /".

property Accept: String read write;

String Accept { get; set; }

Property Accept() As String

property Bearer: String read write;

String Bearer { get; set; }

Property Bearer() As String

Gets the binding which provides properties and methods such as address family, IPv4 address, port number etc for client to connect to the host network.

property BindingV4: Binding read;

Binding BindingV4 { get; }

ReadOnly Property BindingV4() As Binding

Gets the binding which provides properties and methods such as address family, IPv6 address, port number etc for client to connect to the host network.

property BindingV6: Binding read;

Binding BindingV6 { get; }

ReadOnly Property BindingV6() As Binding

method Connect: Connection

Connection Connect()

Function Connect() As Connection

method Connect(host: IPAddress; port: Int32): Connection

Connection Connect(IPAddress host, Int32 port)

Function Connect(host As IPAddress, port As Int32) As Connection

Parameters:

• host:
• port:

method Connect(hostname: String; port: Int32): Connection

Connection Connect(String hostname, Int32 port)

Function Connect(hostname As String, port As Int32) As Connection

Parameters:

• hostname:
• port:

Overloaded. Use to connect the client to a remote network host using the specified host name (HostName) or IP address (HostAddress) and port number (Port) and/or Binding (BindingV4 or BindingV6).

class method Connect(host: IPAddress; port: Int32; binding: Binding): Connection

static Connection Connect(IPAddress host, Int32 port, Binding binding)

Shared Function Connect(host As IPAddress, port As Int32, binding As Binding) As Connection

Parameters:

• host:
• port:
• binding:

Overloaded. Use to connect the client to a remote network host using the specified host name (HostName) or IP address (HostAddress) and port number (Port) and/or Binding (BindingV4 or BindingV6).

class method Connect(hostname: String; port: Int32; binding: Binding): Connection

static Connection Connect(String hostname, Int32 port, Binding binding)

Shared Function Connect(hostname As String, port As Int32, binding As Binding) As Connection

Parameters:

• hostname:
• port:
• binding:

Use the ConnectionClass property to specify an alternative Connection class to be used for out coming data connections. The class described by the assigned Type must be a descendant of Connection, and will be used for all connections that are established after the property has been set. Existing connections are not affected by changing the property.

If ConnectionType is null (default), instances of the Connection base class will be used.

property ConnectionClass: Type read write;

Type ConnectionClass { get; set; }

Property ConnectionClass() As Type

Represents an interface for a connection.

property ConnectionFactory: IConnectionFactory read write;

IConnectionFactory ConnectionFactory { get; set; }

Property ConnectionFactory() As IConnectionFactory

property ConnectionPool: ConnectionPool read write;

ConnectionPool ConnectionPool { get; set; }

Property ConnectionPool() As ConnectionPool

Overloaded. Opens and returns new connection with specified IP address and port.

method ConnectNew(host: IPAddress; port: Int32): Connection

Connection ConnectNew(IPAddress host, Int32 port)

Function ConnectNew(host As IPAddress, port As Int32) As Connection

Parameters:

• host:
• port:

method ConnectNew(hostname: String; port: Int32): Connection

Connection ConnectNew(String hostname, Int32 port)

Function ConnectNew(hostname As String, port As Int32) As Connection

Parameters:

• hostname:
• port:

One of the core methods of the HttpClient class. This method uses the HttpClientRequest class to send messages to the server and the HttpClientResponse to receive server answers.

This method uses the TryDispatch method to send data and raises an HttpException exception if any errors occurs.

method Dispatch(request: HttpClientRequest): HttpClientResponse

HttpClientResponse Dispatch(HttpClientRequest request)

Function Dispatch(request As HttpClientRequest) As HttpClientResponse

Parameters:

• request:

Determines if the specified HostName should be look up only Once per application run (if you establish multiple connections to the server, the subsequent connections will use the cached IPAddress) or Always, for each connect (the Hostname will be resolved again for each subsequet connect).

You'll usually only change this setting off the defaut (Once) if you anticipate the IPAddress of the target host to change frequently.

property DnsResolveType: DnsResolveType read write;

DnsResolveType DnsResolveType { get; set; }

Property DnsResolveType() As DnsResolveType

Set its value to true to enable the Nagle algorithm for send coalescing.

property EnableNagle: Boolean read write;

Boolean EnableNagle { get; set; }

Property EnableNagle() As Boolean

Retrieves an HTTP document (as a string) from the provided URL using the GET HTTP command.

method Get(url: String): String

String Get(String url)

Function Get(url As String) As String

Parameters:

• url:

Retrieves an HTTP document (as a string) in the specified encoding from the provided URL using the GET HTTP command.

method Get(url: String; encoding: Encoding): String

String Get(String url, Encoding encoding)

Function Get(url As String, encoding As Encoding) As String

Parameters:

• url:
• encoding:

Retrieves binary data from the provided URL.

method GetBytes(url: String): array of Byte

Byte[] GetBytes(String url)

Function GetBytes(url As String) As Byte()

Parameters:

• url:

method GetConnection(host: IPAddress; port: Int32): Connection

Connection GetConnection(IPAddress host, Int32 port)

Function GetConnection(host As IPAddress, port As Int32) As Connection

Parameters:

• host:
• port:

method GetDefaultConnectionPool: ConnectionPool

ConnectionPool GetDefaultConnectionPool()

Function GetDefaultConnectionPool() As ConnectionPool

This method is used internally by all other Get* methods of this class. It creates and sends a GET HTTP request to the server and returns a response.

method GetResponse(url: String): HttpClientResponse

HttpClientResponse GetResponse(String url)

Function GetResponse(url As String) As HttpClientResponse

Parameters:

• url:

Gets or sets an Internet Protocol (IP) address.

property HostAddress: IPAddress read write;

IPAddress HostAddress { get; set; }

Property HostAddress() As IPAddress

The server host name or IP address that you intend the client to connect to.

property HostName: String read write;

String HostName { get; set; }

Property HostName() As String

Controls whether to use HTTP Keep-Alive to keep the connection alive between requests.
If enabled (true), once a request is made and a connection is established, this connection is kept open and used for future requests.
If disabled, the connection is closed, and a new connection is created for future requests.
Since establishing a connection is - relatively speaking - a costly and resource intensive operation for the network, compared to sending small amounts of data, it is recommended to keep this option enabled for optimal performance, if requests to the server are done relatively frequently.
For Keep-Alive to work, the option must be supported and enabled on both client and server.

property KeepAlive: Boolean read write;

Boolean KeepAlive { get; set; }

Property KeepAlive() As Boolean

method NewConnection(binding: Binding): Connection

Connection NewConnection(Binding binding)

Function NewConnection(binding As Binding) As Connection

Parameters:

• binding:

This event is fired after the hostname has been successfully resolved.

event OnResolvedHostName: EventHandler<ResolvedHostNameEventArgs>;

delegate EventHandler<ResolvedHostNameEventArgs> OnResolvedHostName()

Event OnResolvedHostName As EventHandler<ResolvedHostNameEventArgs>

This event is fired before the Client attepts to resolve the sepcifed HostName to an IP address. It provides you with an option to perform the resolution yourself, obtain the IP address from an internal cache you're maintaing, or do some other processing (such as for example chaging the hostname to look up).

event OnResolveHostName: EventHandler<ResolveHostNameEventArgs>;

delegate EventHandler<ResolveHostNameEventArgs> OnResolveHostName()

Event OnResolveHostName As EventHandler<ResolveHostNameEventArgs>

Password that will be inserted into the Authorization HTTP header in the request to the server.

property Password: String read write;

String Password { get; set; }

Property Password() As String

The server Port that you intend the client to connect to.

property Port: Int32 read write;

Int32 Port { get; set; }

Property Port() As Int32

Retrieves an HTTP document (as a string) from the provided URL using the POST HTTP command.

method Post(url: String; content: array of Byte): String

String Post(String url, Byte[] content)

Function Post(url As String, content As Byte()) As String

Parameters:

• url:
• content:

Retrieves an HTTP document (as a string) from the provided Url using the POST HTTP command.

method Post(url: String; content: Stream): String

String Post(String url, Stream content)

Function Post(url As String, content As Stream) As String

Parameters:

• url:
• content:

property ProxySettings: HttpProxySettings read;

HttpProxySettings ProxySettings { get; }

ReadOnly Property ProxySettings() As HttpProxySettings

method ReleaseConnection(connection: Connection)

void ReleaseConnection(Connection connection)

Sub ReleaseConnection(connection As Connection)

Parameters:

• connection:

method ResolveHostName

void ResolveHostName()

Sub ResolveHostName()

method ResolveHostNameIfNeeded

void ResolveHostNameIfNeeded()

Sub ResolveHostNameIfNeeded()

property SslOptions: SslConnectionFactory read write;

SslConnectionFactory SslOptions { get; set; }

Property SslOptions() As SslConnectionFactory

Gets or sets the maximum amount of time (in seconds) that a client will wait for a server response within a single request. The default value is 60 seconds (1 minute).

The timeout handling can be activated via the TimeoutEnabled property.

property Timeout: Int32 read write;

Int32 Timeout { get; set; }

Property Timeout() As Int32

This property controls whether the request operation will do an automatic timeout checking. If timeout handling is turned on (i.e. this property is set to true) and a request takes longer than Timeout, it will be terminated.

property TimeoutEnabled: Boolean read write;

Boolean TimeoutEnabled { get; set; }

Property TimeoutEnabled() As Boolean

method TriggerOnResolvedHostName(e: ResolvedHostNameEventArgs)

void TriggerOnResolvedHostName(ResolvedHostNameEventArgs e)

Sub TriggerOnResolvedHostName(e As ResolvedHostNameEventArgs)

Parameters:

• e:

method TriggerOnResolveHostName(e: ResolveHostNameEventArgs)

void TriggerOnResolveHostName(ResolveHostNameEventArgs e)

Sub TriggerOnResolveHostName(e As ResolveHostNameEventArgs)

Parameters:

• e:

The core method of the HttpClient class. This method uses the HttpClientRequest class to send messages to the server and the HttpClientResponse to receive a server answer.

method TryDispatch(request: HttpClientRequest): HttpClientResponse

HttpClientResponse TryDispatch(HttpClientRequest request)

Function TryDispatch(request As HttpClientRequest) As HttpClientResponse

Parameters:

• request:

Enables or disables connection pooling.

property UseConnectionPooling: Boolean read write;

Boolean UseConnectionPooling { get; set; }

Property UseConnectionPooling() As Boolean

Gets or sets the identifier of the software being used to retrieve data via the URL. Some custom HTTP servers check this HTTP header to provide content optimized for particular HTTP browsers (like Internet Explorer or Chrome).

The default value is RemObjects Remoting SDK HTTP Client.

property UserAgent: String read write;

String UserAgent { get; set; }

Property UserAgent() As String

Name that will be inserted into the Authorization HTTP header in the request to the server.

property UserName: String read write;

String UserName { get; set; }

Property UserName() As String

Gets or sets the version identifier of the UserAgent. Can be used to mimic particular browsers like Internet Explorer 6.0

property Version: String read write;

String Version { get; set; }

Property Version() As String

Gets or sets content types that are acceptable for the response. The default value is "text/html, image/gif, image/jpeg, image/png, /".

property Accept: String read write;

String Accept { get; set; }

Property Accept() As String

property Bearer: String read write;

String Bearer { get; set; }

Property Bearer() As String

Gets the binding which provides properties and methods such as address family, IPv4 address, port number etc for client to connect to the host network.

property BindingV4: Binding read;

Binding BindingV4 { get; }

ReadOnly Property BindingV4() As Binding

Gets the binding which provides properties and methods such as address family, IPv6 address, port number etc for client to connect to the host network.

property BindingV6: Binding read;

Binding BindingV6 { get; }

ReadOnly Property BindingV6() As Binding

Use the ConnectionClass property to specify an alternative Connection class to be used for out coming data connections. The class described by the assigned Type must be a descendant of Connection, and will be used for all connections that are established after the property has been set. Existing connections are not affected by changing the property.

If ConnectionType is null (default), instances of the Connection base class will be used.

property ConnectionClass: Type read write;

Type ConnectionClass { get; set; }

Property ConnectionClass() As Type

Represents an interface for a connection.

property ConnectionFactory: IConnectionFactory read write;

IConnectionFactory ConnectionFactory { get; set; }

Property ConnectionFactory() As IConnectionFactory

property ConnectionPool: ConnectionPool read write;

ConnectionPool ConnectionPool { get; set; }

Property ConnectionPool() As ConnectionPool

Determines if the specified HostName should be look up only Once per application run (if you establish multiple connections to the server, the subsequent connections will use the cached IPAddress) or Always, for each connect (the Hostname will be resolved again for each subsequet connect).

You'll usually only change this setting off the defaut (Once) if you anticipate the IPAddress of the target host to change frequently.

property DnsResolveType: DnsResolveType read write;

DnsResolveType DnsResolveType { get; set; }

Property DnsResolveType() As DnsResolveType

Set its value to true to enable the Nagle algorithm for send coalescing.

property EnableNagle: Boolean read write;

Boolean EnableNagle { get; set; }

Property EnableNagle() As Boolean

Gets or sets an Internet Protocol (IP) address.

property HostAddress: IPAddress read write;

IPAddress HostAddress { get; set; }

Property HostAddress() As IPAddress

The server host name or IP address that you intend the client to connect to.

property HostName: String read write;

String HostName { get; set; }

Property HostName() As String

Controls whether to use HTTP Keep-Alive to keep the connection alive between requests.
If enabled (true), once a request is made and a connection is established, this connection is kept open and used for future requests.
If disabled, the connection is closed, and a new connection is created for future requests.
Since establishing a connection is - relatively speaking - a costly and resource intensive operation for the network, compared to sending small amounts of data, it is recommended to keep this option enabled for optimal performance, if requests to the server are done relatively frequently.
For Keep-Alive to work, the option must be supported and enabled on both client and server.

property KeepAlive: Boolean read write;

Boolean KeepAlive { get; set; }

Property KeepAlive() As Boolean

Password that will be inserted into the Authorization HTTP header in the request to the server.

property Password: String read write;

String Password { get; set; }

Property Password() As String

The server Port that you intend the client to connect to.

property Port: Int32 read write;

Int32 Port { get; set; }

Property Port() As Int32

property ProxySettings: HttpProxySettings read;

HttpProxySettings ProxySettings { get; }

ReadOnly Property ProxySettings() As HttpProxySettings

property SslOptions: SslConnectionFactory read write;

SslConnectionFactory SslOptions { get; set; }

Property SslOptions() As SslConnectionFactory

Gets or sets the maximum amount of time (in seconds) that a client will wait for a server response within a single request. The default value is 60 seconds (1 minute).

The timeout handling can be activated via the TimeoutEnabled property.

property Timeout: Int32 read write;

Int32 Timeout { get; set; }

Property Timeout() As Int32

This property controls whether the request operation will do an automatic timeout checking. If timeout handling is turned on (i.e. this property is set to true) and a request takes longer than Timeout, it will be terminated.

property TimeoutEnabled: Boolean read write;

Boolean TimeoutEnabled { get; set; }

Property TimeoutEnabled() As Boolean

Enables or disables connection pooling.

property UseConnectionPooling: Boolean read write;

Boolean UseConnectionPooling { get; set; }

Property UseConnectionPooling() As Boolean

Gets or sets the identifier of the software being used to retrieve data via the URL. Some custom HTTP servers check this HTTP header to provide content optimized for particular HTTP browsers (like Internet Explorer or Chrome).

The default value is RemObjects Remoting SDK HTTP Client.

property UserAgent: String read write;

String UserAgent { get; set; }

Property UserAgent() As String

Name that will be inserted into the Authorization HTTP header in the request to the server.

property UserName: String read write;

String UserName { get; set; }

Property UserName() As String

Gets or sets the version identifier of the UserAgent. Can be used to mimic particular browsers like Internet Explorer 6.0

property Version: String read write;

String Version { get; set; }

Property Version() As String

Overloaded. Use to connect the client to a remote network host using the specified host name (HostName) or IP address (HostAddress) and port number (Port) and/or Binding (BindingV4 or BindingV6).

class method Connect(host: IPAddress; port: Int32; binding: Binding): Connection

static Connection Connect(IPAddress host, Int32 port, Binding binding)

Shared Function Connect(host As IPAddress, port As Int32, binding As Binding) As Connection

Parameters:

• host:
• port:
• binding:

Overloaded. Use to connect the client to a remote network host using the specified host name (HostName) or IP address (HostAddress) and port number (Port) and/or Binding (BindingV4 or BindingV6).

class method Connect(hostname: String; port: Int32; binding: Binding): Connection

static Connection Connect(String hostname, Int32 port, Binding binding)

Shared Function Connect(hostname As String, port As Int32, binding As Binding) As Connection

Parameters:

• hostname:
• port:
• binding:

Creates a new instanse of the HttpClient class.

constructor

HttpClient()

Sub New()

Closes the currently open connection (if present).

method Abort

void Abort()

Sub Abort()

method Connect: Connection

Connection Connect()

Function Connect() As Connection

method Connect(host: IPAddress; port: Int32): Connection

Connection Connect(IPAddress host, Int32 port)

Function Connect(host As IPAddress, port As Int32) As Connection

Parameters:

• host:
• port:

method Connect(hostname: String; port: Int32): Connection

Connection Connect(String hostname, Int32 port)

Function Connect(hostname As String, port As Int32) As Connection

Parameters:

• hostname:
• port:

Overloaded. Opens and returns new connection with specified IP address and port.

method ConnectNew(host: IPAddress; port: Int32): Connection

Connection ConnectNew(IPAddress host, Int32 port)

Function ConnectNew(host As IPAddress, port As Int32) As Connection

Parameters:

• host:
• port:

method ConnectNew(hostname: String; port: Int32): Connection

Connection ConnectNew(String hostname, Int32 port)

Function ConnectNew(hostname As String, port As Int32) As Connection

Parameters:

• hostname:
• port:

One of the core methods of the HttpClient class. This method uses the HttpClientRequest class to send messages to the server and the HttpClientResponse to receive server answers.

This method uses the TryDispatch method to send data and raises an HttpException exception if any errors occurs.

method Dispatch(request: HttpClientRequest): HttpClientResponse

HttpClientResponse Dispatch(HttpClientRequest request)

Function Dispatch(request As HttpClientRequest) As HttpClientResponse

Parameters:

• request:

Retrieves an HTTP document (as a string) from the provided URL using the GET HTTP command.

method Get(url: String): String

String Get(String url)

Function Get(url As String) As String

Parameters:

• url:

Retrieves an HTTP document (as a string) in the specified encoding from the provided URL using the GET HTTP command.

method Get(url: String; encoding: Encoding): String

String Get(String url, Encoding encoding)

Function Get(url As String, encoding As Encoding) As String

Parameters:

• url:
• encoding:

Retrieves binary data from the provided URL.

method GetBytes(url: String): array of Byte

Byte[] GetBytes(String url)

Function GetBytes(url As String) As Byte()

Parameters:

• url:

method GetConnection(host: IPAddress; port: Int32): Connection

Connection GetConnection(IPAddress host, Int32 port)

Function GetConnection(host As IPAddress, port As Int32) As Connection

Parameters:

• host:
• port:

method GetDefaultConnectionPool: ConnectionPool

ConnectionPool GetDefaultConnectionPool()

Function GetDefaultConnectionPool() As ConnectionPool

This method is used internally by all other Get* methods of this class. It creates and sends a GET HTTP request to the server and returns a response.

method GetResponse(url: String): HttpClientResponse

HttpClientResponse GetResponse(String url)

Function GetResponse(url As String) As HttpClientResponse

Parameters:

• url:

method NewConnection(binding: Binding): Connection

Connection NewConnection(Binding binding)

Function NewConnection(binding As Binding) As Connection

Parameters:

• binding:

Retrieves an HTTP document (as a string) from the provided URL using the POST HTTP command.

method Post(url: String; content: array of Byte): String

String Post(String url, Byte[] content)

Function Post(url As String, content As Byte()) As String

Parameters:

• url:
• content:

Retrieves an HTTP document (as a string) from the provided Url using the POST HTTP command.

method Post(url: String; content: Stream): String

String Post(String url, Stream content)

Function Post(url As String, content As Stream) As String

Parameters:

• url:
• content:

method ReleaseConnection(connection: Connection)

void ReleaseConnection(Connection connection)

Sub ReleaseConnection(connection As Connection)

Parameters:

• connection:

method ResolveHostName

void ResolveHostName()

Sub ResolveHostName()

method ResolveHostNameIfNeeded

void ResolveHostNameIfNeeded()

Sub ResolveHostNameIfNeeded()

method TriggerOnResolvedHostName(e: ResolvedHostNameEventArgs)

void TriggerOnResolvedHostName(ResolvedHostNameEventArgs e)

Sub TriggerOnResolvedHostName(e As ResolvedHostNameEventArgs)

Parameters:

• e:

method TriggerOnResolveHostName(e: ResolveHostNameEventArgs)

void TriggerOnResolveHostName(ResolveHostNameEventArgs e)

Sub TriggerOnResolveHostName(e As ResolveHostNameEventArgs)

Parameters:

• e:

The core method of the HttpClient class. This method uses the HttpClientRequest class to send messages to the server and the HttpClientResponse to receive a server answer.

method TryDispatch(request: HttpClientRequest): HttpClientResponse

HttpClientResponse TryDispatch(HttpClientRequest request)

Function TryDispatch(request As HttpClientRequest) As HttpClientResponse

Parameters:

• request:

This event is fired after the hostname has been successfully resolved.

event OnResolvedHostName: EventHandler<ResolvedHostNameEventArgs>;

delegate EventHandler<ResolvedHostNameEventArgs> OnResolvedHostName()

Event OnResolvedHostName As EventHandler<ResolvedHostNameEventArgs>

This event is fired before the Client attepts to resolve the sepcifed HostName to an IP address. It provides you with an option to perform the resolution yourself, obtain the IP address from an internal cache you're maintaing, or do some other processing (such as for example chaging the hostname to look up).

event OnResolveHostName: EventHandler<ResolveHostNameEventArgs>;

delegate EventHandler<ResolveHostNameEventArgs> OnResolveHostName()

Event OnResolveHostName As EventHandler<ResolveHostNameEventArgs>