HttpServerResponse

Overview

The HttpServerResponse class represents server response that is sent back to the client by the HttpServer server. This class cannot be instantiated directly.

This class is descended from the HttpOutgoingRequestResponse class and exposes content properties like ContentString, ContentStream and ContentBytes that are used to provide response data.

Location


 

constructor

Creates a new instance of the HttpServerResponse class.

 

constructor

 

HttpServerResponse()

 

init()

 

Sub New()

constructor (HttpHeaders)  protected    (declared in HttpOutgoingRequestResponse)

 

constructor(header: HttpHeaders)

 

HttpServerResponse(HttpHeaders header)

 

init(_ header: HttpHeaders)

 

Sub New(header As HttpHeaders)

Parameters:

  • header:

Client  protected

Gets flag indicating whether the request is being processed on the client side.

Returns false

 

property Client: Boolean read;

 

Boolean Client { get; }

 

var Client: Boolean { get{} }

 

ReadOnly Property Client() As Boolean

CloneEvents    (declared in HttpRequestResponse)

 

method CloneEvents(source: HttpRequestResponse)

 

void CloneEvents(HttpRequestResponse source)

 

func CloneEvents(_ source: HttpRequestResponse)

 

Sub CloneEvents(source As HttpRequestResponse)

Parameters:

  • source:

CloseStream    (declared in HttpOutgoingRequestResponse)

When ContentSource is set to ContentStream (and a ContentStream is assigned), this property determines if the stream should be closed automatically after sending it to the connection (true) or not (false).

 

property CloseStream: Boolean read write;

 

Boolean CloseStream { get; set; }

 

var CloseStream: Boolean { get{} set{} }

 

Property CloseStream() As Boolean

ContentBytes    (declared in HttpOutgoingRequestResponse)

Assigns a byte array to send back as HTTP body to this property.

 

property ContentBytes: array of Byte read write;

 

Byte[] ContentBytes { get; set; }

 

var ContentBytes: Byte... { get{} set{} }

 

Property ContentBytes() As Byte()

ContentSource    (declared in HttpOutgoingRequestResponse)

Defines which property (ContentBytes, ContentStream or ContantString) will be used to send the body of the response. Assigning any of these three properties will automatically set the ContentSource property so that the content will always be sent from the appropriate source.

 

property ContentSource: ContentSource read;

 

ContentSource ContentSource { get; }

 

var ContentSource: ContentSource { get{} }

 

ReadOnly Property ContentSource() As ContentSource

ContentStream    (declared in HttpOutgoingRequestResponse)

Assigns a stream to send back as HTTP body to this property. When assigned (and ContentSource is set to ContentStream), you can use the CloseStream property to determine if the stream should be closed automatically after sending it to the connection (true) or not (false).

 

property ContentStream: Stream read write;

 

Stream ContentStream { get; set; }

 

var ContentStream: Stream { get{} set{} }

 

Property ContentStream() As Stream

ContentString    (declared in HttpOutgoingRequestResponse)

Assigns a string to send back as HTTP body to this property.

 

property ContentString: String read write;

 

String ContentString { get; set; }

 

var ContentString: String { get{} set{} }

 

Property ContentString() As String

Encoding    (declared in HttpRequestResponse)

 

property Encoding: Encoding read write;

 

Encoding Encoding { get; set; }

 

var Encoding: Encoding { get{} set{} }

 

Property Encoding() As Encoding

FinalizeHeader

This method finalizes the HTTP header.

It sets the correct value of the Content-Length header and sets the HTTP version header to 1.1.

 

method FinalizeHeader

 

void FinalizeHeader()

 

func FinalizeHeader()

 

Sub FinalizeHeader()

HandleOnBytesSent  protected    (declared in HttpOutgoingRequestResponse)

 

method HandleOnBytesSent(sender: Object; e: EventArgs)

 

void HandleOnBytesSent(Object sender, EventArgs e)

 

func HandleOnBytesSent(_ sender: Object, _ e: EventArgs)

 

Sub HandleOnBytesSent(sender As Object, e As EventArgs)

Parameters:

  • sender:
  • e:

HasOnTransferProgress  protected    (declared in HttpRequestResponse)

 

property HasOnTransferProgress: Boolean read;

 

Boolean HasOnTransferProgress { get; }

 

var HasOnTransferProgress: Boolean { get{} }

 

ReadOnly Property HasOnTransferProgress() As Boolean

 

property Header: HttpHeaders read write;

 

HttpHeaders Header { get; set; }

 

var Header: HttpHeaders { get{} set{} }

 

Property Header() As HttpHeaders

HttpCode

Gets or sets the HTTP status code of the response.

The default value is HttpStatusCode.OK

 

property HttpCode: HttpStatusCode read write;

 

HttpStatusCode HttpCode { get; set; }

 

var HttpCode: HttpStatusCode { get{} set{} }

 

Property HttpCode() As HttpStatusCode

KeepAlive    (declared in HttpOutgoingRequestResponse)

 

property KeepAlive: Boolean read write;

 

Boolean KeepAlive { get; set; }

 

var KeepAlive: Boolean { get{} set{} }

 

Property KeepAlive() As Boolean

OnTransferEnd    (declared in HttpRequestResponse)

 

event OnTransferEnd: EventHandler<TransferEndEventArgs>

 

delegate EventHandler<TransferEndEventArgs> OnTransferEnd()

 

__event EventHandler<TransferEndEventArgs>: OnTransferEnd!

 

Event OnTransferEnd As EventHandler<TransferEndEventArgs>

OnTransferProgress    (declared in HttpRequestResponse)

 

event OnTransferProgress: EventHandler<TransferProgressEventArgs>

 

delegate EventHandler<TransferProgressEventArgs> OnTransferProgress()

 

__event EventHandler<TransferProgressEventArgs>: OnTransferProgress!

 

Event OnTransferProgress As EventHandler<TransferProgressEventArgs>

OnTransferStart    (declared in HttpRequestResponse)

 

event OnTransferStart: EventHandler<TransferStartEventArgs>

 

delegate EventHandler<TransferStartEventArgs> OnTransferStart()

 

__event EventHandler<TransferStartEventArgs>: OnTransferStart!

 

Event OnTransferStart As EventHandler<TransferStartEventArgs>

ResponseText

Gets or sets the HTTP status code description (f.e. OK when the Code is 200).

It is up to the caller to ensure that the Code and the ResponseText values correspond to each other.

This property is obsolete, consider using the HttpCode property instead.

The default value is OK

 

property ResponseText: String read;

 

String ResponseText { get; }

 

var ResponseText: String { get{} }

 

ReadOnly Property ResponseText() As String

SendCustomError

 

method SendCustomError(responseCode: HttpStatusCode; contentType: String; message: String)

 

void SendCustomError(HttpStatusCode responseCode, String contentType, String message)

 

func SendCustomError(_ responseCode: HttpStatusCode, _ contentType: String, _ message: String)

 

Sub SendCustomError(responseCode As HttpStatusCode, contentType As String, message As String)

Parameters:

  • responseCode:
  • contentType:
  • message:

SendError (HttpStatusCode, Exception)

Prepares a server response containing an error message.

This method converts the provided exception into string wraps and wraps the resulting error message into an HTML document that is put into the ContentBytes data stream.

 

method SendError(responseCode: HttpStatusCode; exception: Exception)

 

void SendError(HttpStatusCode responseCode, Exception exception)

 

func SendError(_ responseCode: HttpStatusCode, _ exception: Exception)

 

Sub SendError(responseCode As HttpStatusCode, exception As Exception)

Parameters:

  • responseCode: HTTP response code
  • exception: Exception

SendError (HttpStatusCode, String) obsolete

Prepares a server response containing an error message.

This method wraps the provided error message into an HTML document and puts the resulting document into the ContentBytes data stream.

 

method SendError(responseCode: HttpStatusCode; message: String)

 

void SendError(HttpStatusCode responseCode, String message)

 

func SendError(_ responseCode: HttpStatusCode, _ message: String)

 

Sub SendError(responseCode As HttpStatusCode, message As String)

Parameters:

  • responseCode: HTTP response code
  • message: Error message

Server  protected obsolete

Gets flag indicating whether the request is being processed on the server side.

Returns true

 

property Server: Boolean read;

 

Boolean Server { get; }

 

var Server: Boolean { get{} }

 

ReadOnly Property Server() As Boolean

TriggerOnTransferEnd  protected    (declared in HttpRequestResponse)

 

method TriggerOnTransferEnd(direction: TransferDirection)

 

void TriggerOnTransferEnd(TransferDirection direction)

 

func TriggerOnTransferEnd(_ direction: TransferDirection)

 

Sub TriggerOnTransferEnd(direction As TransferDirection)

Parameters:

  • direction:

TriggerOnTransferProgress  protected    (declared in HttpRequestResponse)

 

method TriggerOnTransferProgress(direction: TransferDirection; position: Int64)

 

void TriggerOnTransferProgress(TransferDirection direction, Int64 position)

 

func TriggerOnTransferProgress(_ direction: TransferDirection, _ position: Int64)

 

Sub TriggerOnTransferProgress(direction As TransferDirection, position As Int64)

Parameters:

  • direction:
  • position:

TriggerOnTransferStart  protected    (declared in HttpRequestResponse)

 

method TriggerOnTransferStart(direction: TransferDirection; size: Int64)

 

void TriggerOnTransferStart(TransferDirection direction, Int64 size)

 

func TriggerOnTransferStart(_ direction: TransferDirection, _ size: Int64)

 

Sub TriggerOnTransferStart(direction As TransferDirection, size As Int64)

Parameters:

  • direction:
  • size:

WriteBodyToConnection    (declared in HttpOutgoingRequestResponse)

 

method WriteBodyToConnection(connection: Connection)

 

void WriteBodyToConnection(Connection connection)

 

func WriteBodyToConnection(_ connection: Connection)

 

Sub WriteBodyToConnection(connection As Connection)

Parameters:

  • connection:

WriteHeaderToConnection    (declared in HttpOutgoingRequestResponse)

 

method WriteHeaderToConnection(connection: Connection)

 

void WriteHeaderToConnection(Connection connection)

 

func WriteHeaderToConnection(_ connection: Connection)

 

Sub WriteHeaderToConnection(connection As Connection)

Parameters:

  • connection:

WriteToConnection    (declared in HttpOutgoingRequestResponse)

 

method WriteToConnection(connection: Connection)

 

void WriteToConnection(Connection connection)

 

func WriteToConnection(_ connection: Connection)

 

Sub WriteToConnection(connection As Connection)

Parameters:

  • connection:

 

Client  protected

Gets flag indicating whether the request is being processed on the client side.

Returns false

 

property Client: Boolean read;

 

Boolean Client { get; }

 

var Client: Boolean { get{} }

 

ReadOnly Property Client() As Boolean

CloseStream    (declared in HttpOutgoingRequestResponse)

When ContentSource is set to ContentStream (and a ContentStream is assigned), this property determines if the stream should be closed automatically after sending it to the connection (true) or not (false).

 

property CloseStream: Boolean read write;

 

Boolean CloseStream { get; set; }

 

var CloseStream: Boolean { get{} set{} }

 

Property CloseStream() As Boolean

ContentBytes    (declared in HttpOutgoingRequestResponse)

Assigns a byte array to send back as HTTP body to this property.

 

property ContentBytes: array of Byte read write;

 

Byte[] ContentBytes { get; set; }

 

var ContentBytes: Byte... { get{} set{} }

 

Property ContentBytes() As Byte()

ContentSource    (declared in HttpOutgoingRequestResponse)

Defines which property (ContentBytes, ContentStream or ContantString) will be used to send the body of the response. Assigning any of these three properties will automatically set the ContentSource property so that the content will always be sent from the appropriate source.

 

property ContentSource: ContentSource read;

 

ContentSource ContentSource { get; }

 

var ContentSource: ContentSource { get{} }

 

ReadOnly Property ContentSource() As ContentSource

ContentStream    (declared in HttpOutgoingRequestResponse)

Assigns a stream to send back as HTTP body to this property. When assigned (and ContentSource is set to ContentStream), you can use the CloseStream property to determine if the stream should be closed automatically after sending it to the connection (true) or not (false).

 

property ContentStream: Stream read write;

 

Stream ContentStream { get; set; }

 

var ContentStream: Stream { get{} set{} }

 

Property ContentStream() As Stream

ContentString    (declared in HttpOutgoingRequestResponse)

Assigns a string to send back as HTTP body to this property.

 

property ContentString: String read write;

 

String ContentString { get; set; }

 

var ContentString: String { get{} set{} }

 

Property ContentString() As String

Encoding    (declared in HttpRequestResponse)

 

property Encoding: Encoding read write;

 

Encoding Encoding { get; set; }

 

var Encoding: Encoding { get{} set{} }

 

Property Encoding() As Encoding

HasOnTransferProgress  protected    (declared in HttpRequestResponse)

 

property HasOnTransferProgress: Boolean read;

 

Boolean HasOnTransferProgress { get; }

 

var HasOnTransferProgress: Boolean { get{} }

 

ReadOnly Property HasOnTransferProgress() As Boolean

 

property Header: HttpHeaders read write;

 

HttpHeaders Header { get; set; }

 

var Header: HttpHeaders { get{} set{} }

 

Property Header() As HttpHeaders

HttpCode

Gets or sets the HTTP status code of the response.

The default value is HttpStatusCode.OK

 

property HttpCode: HttpStatusCode read write;

 

HttpStatusCode HttpCode { get; set; }

 

var HttpCode: HttpStatusCode { get{} set{} }

 

Property HttpCode() As HttpStatusCode

KeepAlive    (declared in HttpOutgoingRequestResponse)

 

property KeepAlive: Boolean read write;

 

Boolean KeepAlive { get; set; }

 

var KeepAlive: Boolean { get{} set{} }

 

Property KeepAlive() As Boolean

ResponseText

Gets or sets the HTTP status code description (f.e. OK when the Code is 200).

It is up to the caller to ensure that the Code and the ResponseText values correspond to each other.

This property is obsolete, consider using the HttpCode property instead.

The default value is OK

 

property ResponseText: String read;

 

String ResponseText { get; }

 

var ResponseText: String { get{} }

 

ReadOnly Property ResponseText() As String

Server  protected obsolete

Gets flag indicating whether the request is being processed on the server side.

Returns true

 

property Server: Boolean read;

 

Boolean Server { get; }

 

var Server: Boolean { get{} }

 

ReadOnly Property Server() As Boolean

 

constructor

Creates a new instance of the HttpServerResponse class.

 

constructor

 

HttpServerResponse()

 

init()

 

Sub New()

constructor (HttpHeaders)  protected    (declared in HttpOutgoingRequestResponse)

 

constructor(header: HttpHeaders)

 

HttpServerResponse(HttpHeaders header)

 

init(_ header: HttpHeaders)

 

Sub New(header As HttpHeaders)

Parameters:

  • header:

CloneEvents    (declared in HttpRequestResponse)

 

method CloneEvents(source: HttpRequestResponse)

 

void CloneEvents(HttpRequestResponse source)

 

func CloneEvents(_ source: HttpRequestResponse)

 

Sub CloneEvents(source As HttpRequestResponse)

Parameters:

  • source:

FinalizeHeader

This method finalizes the HTTP header.

It sets the correct value of the Content-Length header and sets the HTTP version header to 1.1.

 

method FinalizeHeader

 

void FinalizeHeader()

 

func FinalizeHeader()

 

Sub FinalizeHeader()

HandleOnBytesSent  protected    (declared in HttpOutgoingRequestResponse)

 

method HandleOnBytesSent(sender: Object; e: EventArgs)

 

void HandleOnBytesSent(Object sender, EventArgs e)

 

func HandleOnBytesSent(_ sender: Object, _ e: EventArgs)

 

Sub HandleOnBytesSent(sender As Object, e As EventArgs)

Parameters:

  • sender:
  • e:

SendCustomError

 

method SendCustomError(responseCode: HttpStatusCode; contentType: String; message: String)

 

void SendCustomError(HttpStatusCode responseCode, String contentType, String message)

 

func SendCustomError(_ responseCode: HttpStatusCode, _ contentType: String, _ message: String)

 

Sub SendCustomError(responseCode As HttpStatusCode, contentType As String, message As String)

Parameters:

  • responseCode:
  • contentType:
  • message:

SendError (HttpStatusCode, Exception)

Prepares a server response containing an error message.

This method converts the provided exception into string wraps and wraps the resulting error message into an HTML document that is put into the ContentBytes data stream.

 

method SendError(responseCode: HttpStatusCode; exception: Exception)

 

void SendError(HttpStatusCode responseCode, Exception exception)

 

func SendError(_ responseCode: HttpStatusCode, _ exception: Exception)

 

Sub SendError(responseCode As HttpStatusCode, exception As Exception)

Parameters:

  • responseCode: HTTP response code
  • exception: Exception

SendError (HttpStatusCode, String) obsolete

Prepares a server response containing an error message.

This method wraps the provided error message into an HTML document and puts the resulting document into the ContentBytes data stream.

 

method SendError(responseCode: HttpStatusCode; message: String)

 

void SendError(HttpStatusCode responseCode, String message)

 

func SendError(_ responseCode: HttpStatusCode, _ message: String)

 

Sub SendError(responseCode As HttpStatusCode, message As String)

Parameters:

  • responseCode: HTTP response code
  • message: Error message

TriggerOnTransferEnd  protected    (declared in HttpRequestResponse)

 

method TriggerOnTransferEnd(direction: TransferDirection)

 

void TriggerOnTransferEnd(TransferDirection direction)

 

func TriggerOnTransferEnd(_ direction: TransferDirection)

 

Sub TriggerOnTransferEnd(direction As TransferDirection)

Parameters:

  • direction:

TriggerOnTransferProgress  protected    (declared in HttpRequestResponse)

 

method TriggerOnTransferProgress(direction: TransferDirection; position: Int64)

 

void TriggerOnTransferProgress(TransferDirection direction, Int64 position)

 

func TriggerOnTransferProgress(_ direction: TransferDirection, _ position: Int64)

 

Sub TriggerOnTransferProgress(direction As TransferDirection, position As Int64)

Parameters:

  • direction:
  • position:

TriggerOnTransferStart  protected    (declared in HttpRequestResponse)

 

method TriggerOnTransferStart(direction: TransferDirection; size: Int64)

 

void TriggerOnTransferStart(TransferDirection direction, Int64 size)

 

func TriggerOnTransferStart(_ direction: TransferDirection, _ size: Int64)

 

Sub TriggerOnTransferStart(direction As TransferDirection, size As Int64)

Parameters:

  • direction:
  • size:

WriteBodyToConnection    (declared in HttpOutgoingRequestResponse)

 

method WriteBodyToConnection(connection: Connection)

 

void WriteBodyToConnection(Connection connection)

 

func WriteBodyToConnection(_ connection: Connection)

 

Sub WriteBodyToConnection(connection As Connection)

Parameters:

  • connection:

WriteHeaderToConnection    (declared in HttpOutgoingRequestResponse)

 

method WriteHeaderToConnection(connection: Connection)

 

void WriteHeaderToConnection(Connection connection)

 

func WriteHeaderToConnection(_ connection: Connection)

 

Sub WriteHeaderToConnection(connection As Connection)

Parameters:

  • connection:

WriteToConnection    (declared in HttpOutgoingRequestResponse)

 

method WriteToConnection(connection: Connection)

 

void WriteToConnection(Connection connection)

 

func WriteToConnection(_ connection: Connection)

 

Sub WriteToConnection(connection As Connection)

Parameters:

  • connection:

 

OnTransferEnd    (declared in HttpRequestResponse)

 

event OnTransferEnd: EventHandler<TransferEndEventArgs>

 

delegate EventHandler<TransferEndEventArgs> OnTransferEnd()

 

__event EventHandler<TransferEndEventArgs>: OnTransferEnd!

 

Event OnTransferEnd As EventHandler<TransferEndEventArgs>

OnTransferProgress    (declared in HttpRequestResponse)

 

event OnTransferProgress: EventHandler<TransferProgressEventArgs>

 

delegate EventHandler<TransferProgressEventArgs> OnTransferProgress()

 

__event EventHandler<TransferProgressEventArgs>: OnTransferProgress!

 

Event OnTransferProgress As EventHandler<TransferProgressEventArgs>

OnTransferStart    (declared in HttpRequestResponse)

 

event OnTransferStart: EventHandler<TransferStartEventArgs>

 

delegate EventHandler<TransferStartEventArgs> OnTransferStart()

 

__event EventHandler<TransferStartEventArgs>: OnTransferStart!

 

Event OnTransferStart As EventHandler<TransferStartEventArgs>