Objeck Documentation

All Bundles

Response

Web server response

Operations

New
AddCookie
GetCode
GetContent
GetCookie
GetCookies
GetForwardAlias
GetHeader
GetHeaders
GetReason
GetStringContent
HasContent
HasForwardAlias
HasHeader
HasStaticHandler
RemoveCookie
RemoveHeader
SetCode
SetCodeContent
SetCodeContentCompression
SetCodeType
SetCodeTypeContent
SetCompression
SetContent
SetContentCompression
SetContentType
SetForwardAlias
SetHeader
SetReason
ToString

AddCookie

Adds a cookie

method : public : AddCookie(cookie:Cookie) ~ Nil

Parameters

Name	Type	Description
cookie	Cookie	cookie

GetCode

Get the response code

method : public : GetCode() ~ Int

Return

Type	Description
Int	response code

GetContent

Get the response content

method : public : GetContent() ~ Byte[]

Return

Type	Description
Byte	response content

GetCookie

Updates a cookie

method : public : GetCookie(name:String) ~ Cookie

Parameters

Name	Type	Description
name	String	cookie name

GetCookies

Gets all cookies

method : public : GetCookies() ~ Vector<Cookie>

Return

Type	Description
Vector<Cookie>	all cookies

GetForwardAlias

Gets the forward page alias

method : public : GetForwardAlias() ~ String

Return

Type	Description
String	forward page alias

GetHeader

Gets a response header

method : public : GetHeader(name:String) ~ String

Parameters

Name	Type	Description
name	String	header name

Return

Type	Description
String	response header

GetHeaders

Gets response headers

method : public : GetHeaders() ~ Map<String,String>

Return

Type	Description
Map<String,String>	response headers

GetReason

Get the reason string

method : public : GetReason() ~ String

Return

Type	Description
String	reason sting

GetStringContent

Get the response content as string

method : public : GetStringContent() ~ String

Return

Type	Description
String	response content as string

HasContent

Checks for request body content

method : public : HasContent() ~ Bool

Return

Type	Description
Bool	true if content exists, false otherwise

HasForwardAlias

Checks the forward page alias

method : public : HasForwardAlias() ~ Bool

Return

Type	Description
Bool	true if forward page alias exists, false otherwise

HasHeader

Check for a response header

method : public : HasHeader(name:String) ~ Bool

Parameters

Name	Type	Description
name	String	header name

Return

Type	Description
Bool	true if header exists, false otherwise

HasStaticHandler

Check to see if the response has configured handler

method : public : HasStaticHandler() ~ Bool

Return

Type	Description
Bool	true if handler exists, false otherwise

New

Constructor

New(server_config:WebServerConfig, request_path:String)

Parameters

Name	Type	Description
server_config	WebServerConfig	web server configuration
request_path	String	HTTP request path

RemoveCookie

Removes a cookie

method : public : RemoveCookie(name:String) ~ Nil

Parameters

Name	Type	Description
name	String	cookie name

RemoveHeader

Removed a response header

method : public : RemoveHeader(name:String) ~ Nil

Parameters

Name	Type	Description
name	String	header name

SetCode

Set response code

method : public : SetCode(code:Int) ~ Nil

Parameters

Name	Type	Description
code	Int	response code

SetCodeContent

Set response code and content

method : public : SetCodeContent(code:Int, content:Byte[]) ~ Nil

Parameters

Name	Type	Description
code	Int	response code
content	Byte	response content

SetCodeContent

Set response code and content

method : public : SetCodeContent(code:Int, content:String) ~ Nil

Parameters

Name	Type	Description
code	Int	response code
content	String	response content

SetCodeContentCompression

Set response code, content and compression type

method : public : SetCodeContentCompression(code:Int, content:String, compression:Compression) ~ Nil

Parameters

Name	Type	Description
code	Int	response code
content	String	response content
compression	Compression	response compression (br = Brotli, deflate = zlib, gzip = GNU zip)

SetCodeContentCompression

Set response code, content and compression type

method : public : SetCodeContentCompression(code:Int, content:Byte[], compression:Compression) ~ Nil

Parameters

Name	Type	Description
code	Int	response code
content	Byte	response content
compression	Compression	response compression (br = Brotli, deflate = zlib, gzip = GNU zip)

SetCodeType

Set response code and type

method : public : SetCodeType(code:Int, type:String) ~ Nil

Parameters

Name	Type	Description
code	Int	response code
type	String	content type

SetCodeTypeContent

Set response code, type and content

method : public : SetCodeTypeContent(code:Int, type:String, content:Byte[]) ~ Nil

Parameters

Name	Type	Description
code	Int	response code
type	String	content type
content	Byte	response content

SetCodeTypeContent

Set response code and content

method : public : SetCodeTypeContent(code:Int, type:String, content:String) ~ Nil

Parameters

Name	Type	Description
code	Int	response code
type	String	content type
content	String	response content

SetCompression

Set the response compression, should be called after the content is set

method : public : SetCompression(compression:Compression) ~ Nil

Parameters

Name	Type	Description
compression	Compression	response compression (br = Brotli, deflate = zlib, gzip = GNU zip)

SetContent

Set response content

method : public : SetContent(content:Byte[]) ~ Nil

Parameters

Name	Type	Description
content	Byte	response content

SetContent

Set response code

method : public : SetContent(content:String) ~ Nil

Parameters

Name	Type	Description
content	String	response content

SetContentCompression

Set content and compression type

method : public : SetContentCompression(content:String, compression:Compression) ~ Nil

Parameters

Name	Type	Description
content	String	response content
compression	Compression	response compression (br = Brotli, deflate = zlib, gzip = GNU zip)

SetContentCompression

Set content and compression type

method : public : SetContentCompression(content:Byte[], compression:Compression) ~ Nil

Parameters

Name	Type	Description
content	Byte	response content
compression	Compression	response compression (br = Brotli, deflate = zlib, gzip = GNU zip)

SetContentType

Sets the content type

method : public : SetContentType(type:String) ~ Nil

Parameters

Name	Type	Description
type	String	content type

SetForwardAlias

Set the forward page alias

method : public : SetForwardAlias(name:String) ~ Bool

Parameters

Name	Type	Description
name	String	forward page alias

Return

Type	Description
Bool	true if set, false otherwise

SetHeader

Sets a response header

method : public : SetHeader(name:String, value:String) ~ Nil

Parameters

Name	Type	Description
name	String	header name
value	String	header value

SetReason

Set response reason

method : public : SetReason(reason:String) ~ Nil

Parameters

Name	Type	Description
reason	String	response reason

ToString

Get the reason string

method : public : ToString() ~ String

Return

Type	Description
String	reason sting