IpHttpServerChannelInfo

Overview

The IpHttpServerChannelInfo class is used internally by the IpHttpServerChannel to store all information about the request currently processed, including related HttpServerRequest and HttpServerResponse instances.

This class is inherited from the IpServerChannelInfo class and implements the IIpServerChannelInfo, IHttpRequest, IHttpResponse, IHttpHeader and IChannel interfaces.

Note that some of the implemented properties have empty set methods, needed only to fully implement one of the interfaces listed above.

Location


 

constructor (ServerChannel)  protected    (declared in ServerChannelInfo)

Creates an instance of an object with the given ServerChannel.

 

constructor(serverChannel: ServerChannel)

 

IpHttpServerChannelInfo(ServerChannel serverChannel)

 

Sub New(serverChannel As ServerChannel)

Parameters:

  • serverChannel: A given server channel.

constructor (ServerChannel, Connection)    (declared in IpServerChannelInfo)

 

constructor(serverChannel: ServerChannel; connection: Connection)

 

IpHttpServerChannelInfo(ServerChannel serverChannel, Connection connection)

 

Sub New(serverChannel As ServerChannel, connection As Connection)

Parameters:

  • serverChannel:
  • connection:

 

constructor(serverChannel: ServerChannel; connection: Connection; request: HttpServerRequest; response: HttpServerResponse)

 

IpHttpServerChannelInfo(ServerChannel serverChannel, Connection connection, HttpServerRequest request, HttpServerResponse response)

 

Sub New(serverChannel As ServerChannel, connection As Connection, request As HttpServerRequest, response As HttpServerResponse)

Parameters:

  • serverChannel:
  • connection:
  • request:
  • response:

AuthPassword

Gets the Basic Http Authentication password (if provided) of the incoming request.

Note that any changes to the value of this property are ignored.

 

property AuthPassword: String read write;

 

String AuthPassword { get; set; }

 

Property AuthPassword() As String

AuthUsername

Gets the Basic Http Authentication user name (if provided) of the incoming request.

Note that any changes to the value of this property are ignored.

 

property AuthUsername: String read write;

 

String AuthUsername { get; set; }

 

Property AuthUsername() As String

Connection    (declared in IpServerChannelInfo)

Remote client connection.

 

property Connection: Connection read;

 

Connection Connection { get; }

 

ReadOnly Property Connection() As Connection

ContentType

Gets the value of the Content-Type Http header of the incoming request.

 

property ContentType: String read;

 

String ContentType { get; }

 

ReadOnly Property ContentType() As String

GetQueryString

Returnsthe corresponding part of the query string. If the request was, for example, done via a URL like http://localhost:8099/rodl?service=Test, the GetQueryString('service') would return 'Test'.

If there is no QueryString part with the requested name, this method returns null.

 

method GetQueryString(key: String): String

 

String GetQueryString(String key)

 

Function GetQueryString(key As String) As String

Parameters:

  • key: Name of the requested QueryString part

Header

Gets a reference to the current instance.

Note that this class implements the IHttpHeader interface.

 

property Header: IHttpHeader read;

 

IHttpHeader Header { get; }

 

ReadOnly Property Header() As IHttpHeader

Item

Gets the value of the Http header of the incoming request with the provided name.

Note that any changes to the value of this property are ignored.

 

property Item[name: String]: String read write;

 

String Item[String name] { get; set; }

 

Property Item(name As String) As String

LocalEndPoint    (declared in IpServerChannelInfo)

 

property LocalEndPoint: IPEndPoint read;

 

IPEndPoint LocalEndPoint { get; }

 

ReadOnly Property LocalEndPoint() As IPEndPoint

Method

Gets the type (GET, POST etc) of the incoming request.

 

property Method: String read;

 

String Method { get; }

 

ReadOnly Property Method() As String

RemoteEndPoint    (declared in IpServerChannelInfo)

 

property RemoteEndPoint: IPEndPoint read;

 

IPEndPoint RemoteEndPoint { get; }

 

ReadOnly Property RemoteEndPoint() As IPEndPoint

Request

Gets the HttpServerRequest instance that represents the current incoming HTTP request.

 

property Request: HttpServerRequest read;

 

HttpServerRequest Request { get; }

 

ReadOnly Property Request() As HttpServerRequest

Response

Gets the HttpServerResponse instance that represents the current HTTP response. The retrieved instance can be used to compose a response to the request of the remote client.

 

property Response: HttpServerResponse read;

 

HttpServerResponse Response { get; }

 

ReadOnly Property Response() As HttpServerResponse

ServerChannel    (declared in ServerChannelInfo)

Returns the server channel instance provided in constructor.

 

property ServerChannel: ServerChannel read;

 

ServerChannel ServerChannel { get; }

 

ReadOnly Property ServerChannel() As ServerChannel

TargetUrl

Gets the URL used by remote client to send the request. This property can be useful to implement services like REST.

Note that any changes to the value of this property are ignored.

 

property TargetUrl: String read write;

 

String TargetUrl { get; set; }

 

Property TargetUrl() As String

UsesAuthentication

Gets the value indicating whether an incoming HTTP request contains Basic Http Authentication information.

Note that any changes to the value of this property are ignored.

 

property UsesAuthentication: Boolean read write;

 

Boolean UsesAuthentication { get; set; }

 

Property UsesAuthentication() As Boolean

 

AuthPassword

Gets the Basic Http Authentication password (if provided) of the incoming request.

Note that any changes to the value of this property are ignored.

 

property AuthPassword: String read write;

 

String AuthPassword { get; set; }

 

Property AuthPassword() As String

AuthUsername

Gets the Basic Http Authentication user name (if provided) of the incoming request.

Note that any changes to the value of this property are ignored.

 

property AuthUsername: String read write;

 

String AuthUsername { get; set; }

 

Property AuthUsername() As String

Connection    (declared in IpServerChannelInfo)

Remote client connection.

 

property Connection: Connection read;

 

Connection Connection { get; }

 

ReadOnly Property Connection() As Connection

ContentType

Gets the value of the Content-Type Http header of the incoming request.

 

property ContentType: String read;

 

String ContentType { get; }

 

ReadOnly Property ContentType() As String

Header

Gets a reference to the current instance.

Note that this class implements the IHttpHeader interface.

 

property Header: IHttpHeader read;

 

IHttpHeader Header { get; }

 

ReadOnly Property Header() As IHttpHeader

Item

Gets the value of the Http header of the incoming request with the provided name.

Note that any changes to the value of this property are ignored.

 

property Item[name: String]: String read write;

 

String Item[String name] { get; set; }

 

Property Item(name As String) As String

LocalEndPoint    (declared in IpServerChannelInfo)

 

property LocalEndPoint: IPEndPoint read;

 

IPEndPoint LocalEndPoint { get; }

 

ReadOnly Property LocalEndPoint() As IPEndPoint

Method

Gets the type (GET, POST etc) of the incoming request.

 

property Method: String read;

 

String Method { get; }

 

ReadOnly Property Method() As String

RemoteEndPoint    (declared in IpServerChannelInfo)

 

property RemoteEndPoint: IPEndPoint read;

 

IPEndPoint RemoteEndPoint { get; }

 

ReadOnly Property RemoteEndPoint() As IPEndPoint

Request

Gets the HttpServerRequest instance that represents the current incoming HTTP request.

 

property Request: HttpServerRequest read;

 

HttpServerRequest Request { get; }

 

ReadOnly Property Request() As HttpServerRequest

Response

Gets the HttpServerResponse instance that represents the current HTTP response. The retrieved instance can be used to compose a response to the request of the remote client.

 

property Response: HttpServerResponse read;

 

HttpServerResponse Response { get; }

 

ReadOnly Property Response() As HttpServerResponse

ServerChannel    (declared in ServerChannelInfo)

Returns the server channel instance provided in constructor.

 

property ServerChannel: ServerChannel read;

 

ServerChannel ServerChannel { get; }

 

ReadOnly Property ServerChannel() As ServerChannel

TargetUrl

Gets the URL used by remote client to send the request. This property can be useful to implement services like REST.

Note that any changes to the value of this property are ignored.

 

property TargetUrl: String read write;

 

String TargetUrl { get; set; }

 

Property TargetUrl() As String

UsesAuthentication

Gets the value indicating whether an incoming HTTP request contains Basic Http Authentication information.

Note that any changes to the value of this property are ignored.

 

property UsesAuthentication: Boolean read write;

 

Boolean UsesAuthentication { get; set; }

 

Property UsesAuthentication() As Boolean

 

constructor (ServerChannel)  protected    (declared in ServerChannelInfo)

Creates an instance of an object with the given ServerChannel.

 

constructor(serverChannel: ServerChannel)

 

IpHttpServerChannelInfo(ServerChannel serverChannel)

 

Sub New(serverChannel As ServerChannel)

Parameters:

  • serverChannel: A given server channel.

constructor (ServerChannel, Connection)    (declared in IpServerChannelInfo)

 

constructor(serverChannel: ServerChannel; connection: Connection)

 

IpHttpServerChannelInfo(ServerChannel serverChannel, Connection connection)

 

Sub New(serverChannel As ServerChannel, connection As Connection)

Parameters:

  • serverChannel:
  • connection:

 

constructor(serverChannel: ServerChannel; connection: Connection; request: HttpServerRequest; response: HttpServerResponse)

 

IpHttpServerChannelInfo(ServerChannel serverChannel, Connection connection, HttpServerRequest request, HttpServerResponse response)

 

Sub New(serverChannel As ServerChannel, connection As Connection, request As HttpServerRequest, response As HttpServerResponse)

Parameters:

  • serverChannel:
  • connection:
  • request:
  • response:

GetQueryString

Returnsthe corresponding part of the query string. If the request was, for example, done via a URL like http://localhost:8099/rodl?service=Test, the GetQueryString('service') would return 'Test'.

If there is no QueryString part with the requested name, this method returns null.

 

method GetQueryString(key: String): String

 

String GetQueryString(String key)

 

Function GetQueryString(key As String) As String

Parameters:

  • key: Name of the requested QueryString part