HSB.Response Class Reference

Public Member Functions
	Response (Socket socket, Request request, Configuration c, SslStream? sslStream)
void	Send (byte[] data, bool disconnect=true)
	Send an un modified byte array to to the socket.
void	Send (string data, string mimeType="text/plain", int statusCode=HTTP_CODES.OK, Dictionary< string, string >? customHeaders=null)
	Sends an HTTP Response with the body passed as parameter.
void	SendHTMLFile (string path, bool process=false, Dictionary< string, string >? customHeaders=null)
	Loads and HTML file from path and sends it as HTTP Response with mimeType = text/html Optionally it can provides a basic processor function.
void	SendHTMLContent (string content, bool process=false, int statusCode=HTTP_CODES.OK, string encoding="UTF-8", Dictionary< string, string >? customHeaders=null)
	Sends an html page passed as string.
void	SendFile (string absPath, string? mimeType=null, int statusCode=HTTP_CODES.OK, Dictionary< string, string >? customHeaders=null)
	Loads a file from a given path and sends an HTTP Response.
void	SendFile (byte[] data, string mimeType, int statusCode=HTTP_CODES.OK, Dictionary< string, string >? customHeaders=null)
	Sends data to the client.
void	SendObject (object obj, string fileName="")
	Sends a generic object to the client, with possible optimization (string, byte[], FilePart, generic object)
void	SendFile (FilePart filePart, int statusCode=HTTP_CODES.OK, Dictionary< string, string >? customHeaders=null)
	Send a FilePart to the client.
void	SendCode (int statusCode)
	Send an HTTP Response with no body but with given status code.
void	Send (int statusCode)
	Shorthand for SendCode.
void	Redirect (string route, int statusCode=HTTP_CODES.FOUND)
	Sends a redirect to the client.
void	Redirect (Servlet s, int statusCode=HTTP_CODES.FOUND)
	Redirects to a given servlet.
void	E400 ()
	Bad Request.
void	E401 ()
	Unauthorized.
void	E404 ()
	Not Found.
void	E500 ()
	Internal Server Error.
void	JSON (string content)
	Sends a HTTP Response with a JSON body passed as parameter.
void	JSON< T > (T o, JsonSerializerOptions options)
	Serializes and sends an Object in JSON format.
void	JSON< T > (T o, bool includeFields=true, bool WriteIndented=true)
	Serialize and sends an Object in JSON Format.
void	SendJSON< T > (T o, JsonSerializerOptions options)
	Alternate name for function JSON.
void	SendJSON< T > (T o, bool includeFields=true)
	Alternate name for function JSON.
void	SendJSON (string content)
void	AddAttribute (string name, string value)
	Adds an attribute to the HTML file that will be processed, if it already exists it will be overwritten.
void	RemoveAttribute (string name)
	Removes an attribute to the HTML file that will be processed.
string	GetAttribute (string name)
	Retrieves the value of an attribute to the HTML file that will be processed, if doesn't exists it will return an empty string.

Detailed Description

Definition at line 14 of file Response.cs.

Constructor & Destructor Documentation

Response()

HSB.Response.Response	(	Socket	socket,
		Request	request,
		Configuration	c,
		SslStream?	sslStream
	)

Definition at line 25 of file Response.cs.

    {
        this.socket = socket;
        this.request = request;
        this.sslStream = sslStream;
        config = c;
    }

Member Function Documentation

AddAttribute()

void HSB.Response.AddAttribute	(	string	name,
		string	value
	)

Adds an attribute to the HTML file that will be processed, if it already exists it will be overwritten.

Parameters

name	Name of the attribute
value	Value of the attribute

Definition at line 413 of file Response.cs.

    {
        if (attributes.ContainsKey(name))
            attributes[name] = value;
        else
            attributes.Add(name, value);
    }

E400()

void HSB.Response.E400

(

)

Bad Request.

Definition at line 243 of file Response.cs.

    {
        SendCode(HTTP_CODES.BAD_REQUEST);
    }

E401()

void HSB.Response.E401

(

)

Unauthorized.

Definition at line 250 of file Response.cs.

    {
        SendCode(HTTP_CODES.UNAUTHORIZED);
    }

E404()

void HSB.Response.E404

(

)

Not Found.

Definition at line 257 of file Response.cs.

    {
        SendCode(HTTP_CODES.NOT_FOUND);
    }

E500()

void HSB.Response.E500

(

)

Internal Server Error.

Definition at line 264 of file Response.cs.

    {
        SendCode(HTTP_CODES.INTERNAL_SERVER_ERROR);
    }

GetAttribute()

string HSB.Response.GetAttribute

(

string

name

)

Retrieves the value of an attribute to the HTML file that will be processed, if doesn't exists it will return an empty string.

Parameters

name	Name of the attribute

Definition at line 432 of file Response.cs.

    {
        return attributes[name] ?? "";
    }

JSON()

void HSB.Response.JSON

(

string

content

)

Sends a HTTP Response with a JSON body passed as parameter.

Parameters

content

String of the body in JSON format

Definition at line 272 of file Response.cs.

    {
        Send(content, "application/json");
    }

JSON< T >() [1/2]

void HSB.Response.JSON< T >	(	T	o,
		bool	includeFields = true,
		bool	WriteIndented = true
	)

Serialize and sends an Object in JSON Format.

Template Parameters

T

Parameters

o
includeFields	Whether or not or not include fields of the object

Definition at line 291 of file Response.cs.

    {
        JsonSerializerOptions jo = new()
        {
            IncludeFields = includeFields,
            MaxDepth = 0,
            WriteIndented = WriteIndented
        };
 
        JSON(JsonSerializer.Serialize(o, jo));
    }

JSON< T >() [2/2]

void HSB.Response.JSON< T >	(	T	o,
		JsonSerializerOptions	options
	)

Serializes and sends an Object in JSON format.

Parameters

o	Object to be serialized and sended as response
options	Options for the serializer (System.Text.Json.JsonSerializer)

Definition at line 281 of file Response.cs.

    {
        JSON(JsonSerializer.Serialize(o, options));
    }

Redirect() [1/2]

void HSB.Response.Redirect	(	Servlet	s,
		int	statusCode = HTTP_CODES::FOUND
	)

Redirects to a given servlet.

Parameters

s
statusCode

Definition at line 235 of file Response.cs.

    {
        Redirect(s.GetRoute(), statusCode);
    }

Redirect() [2/2]

void HSB.Response.Redirect	(	string	route,
		int	statusCode = HTTP_CODES::FOUND
	)

Sends a redirect to the client.

Parameters

route

Definition at line 216 of file Response.cs.

    {
        if (statusCode < 300 && statusCode > 399)
            throw new InvalidHttpCodeException(statusCode);
 
        string response = GetHeaders(
           statusCode,
            0,
            MimeTypeUtils.TEXT_PLAIN,
            new Dictionary<string, string>() { { "Location", route } }
        ) + NEW_LINE;
 
        Send(Encoding.UTF8.GetBytes(response));
    }

RemoveAttribute()

void HSB.Response.RemoveAttribute

(

string

name

)

Removes an attribute to the HTML file that will be processed.

Parameters

name	Name of the attribute

Definition at line 424 of file Response.cs.

    {
        attributes.Remove(name);
    }

Send() [1/3]

void HSB.Response.Send	(	byte[]	data,
		bool	disconnect = true
	)

Send an un modified byte array to to the socket.

Parameters

data

Definition at line 40 of file Response.cs.

    {
        try
        {
            if (sslStream != null)
            {
                sslStream.Write(data);
                if (disconnect)
                    sslStream.Close();
            }
            else
            {
                int totalBytes = socket.Send(data);
                socket.Disconnect(disconnect);
            }
            data = [];
        }
        catch (Exception e)
        {
            Terminal.ERROR($"Error sending data ->\n {e}");
        }
    }

Send() [2/3]

void HSB.Response.Send

(

int

statusCode

)

Shorthand for SendCode.

Parameters

statusCode

Definition at line 208 of file Response.cs.

    {
        SendCode(statusCode);
    }

Send() [3/3]

void HSB.Response.Send	(	string	data,
		string	mimeType = "text/plain",
		int	statusCode = HTTP_CODES::OK,
		Dictionary< string, string >?	customHeaders = null
	)

Sends an HTTP Response with the body passed as parameter.

Parameters

data	Body of the response
mimeType	MimeType of the body
statusCode	Response status code

Definition at line 68 of file Response.cs.

    {
        string _mime = mimeType;
        string resp = GetHeaders(statusCode, Encoding.UTF8.GetBytes(data).Length, _mime, customHeaders) + data;
 
        Send(Encoding.UTF8.GetBytes(resp));
 
    }

SendCode()

void HSB.Response.SendCode

(

int

statusCode

)

Send an HTTP Response with no body but with given status code.

Parameters

statusCode

Definition at line 198 of file Response.cs.

    {
        string resp = GetHeaders(statusCode, 0, MimeTypeUtils.TEXT_PLAIN) + NEW_LINE;
 
        Send(Encoding.UTF8.GetBytes(resp));
    }

SendFile() [1/3]

void HSB.Response.SendFile	(	byte[]	data,
		string	mimeType,
		int	statusCode = HTTP_CODES::OK,
		Dictionary< string, string >?	customHeaders = null
	)

Sends data to the client.

Parameters

data
mimeType
statusCode

Definition at line 147 of file Response.cs.

    {
        string _mime = mimeType;
        string headers = GetHeaders(statusCode, data.Length, _mime, customHeaders);
        byte[] headersBytes = Encoding.UTF8.GetBytes(headers);
        byte[] responseBytes = new byte[data.Length + headersBytes.Length];
 
        headersBytes.CopyTo(responseBytes, 0);
        data.CopyTo(responseBytes, headersBytes.Length);
 
        Send(responseBytes);
        //clear memory after sending
        data = [];
        headersBytes = [];
        responseBytes = [];
    }

SendFile() [2/3]

void HSB.Response.SendFile	(	FilePart	filePart,
		int	statusCode = HTTP_CODES::OK,
		Dictionary< string, string >?	customHeaders = null
	)

Send a FilePart to the client.

Parameters

filePart
statusCode
customHeaders

Definition at line 190 of file Response.cs.

    {
        SendFile(filePart.GetBytes(), filePart.GetMimeType(), statusCode, customHeaders);
    }

SendFile() [3/3]

void HSB.Response.SendFile	(	string	absPath,
		string?	mimeType = null,
		int	statusCode = HTTP_CODES::OK,
		Dictionary< string, string >?	customHeaders = null
	)

Loads a file from a given path and sends an HTTP Response.

Parameters

absPath	Path (absolute) of the file
mimeType	MimeType of the file
statusCode	Response status code

Definition at line 122 of file Response.cs.

    {
        var data = File.ReadAllBytes(absPath);
 
        string _mime = mimeType ?? MimeTypeUtils.GetMimeType(Path.GetExtension(absPath)) ?? MimeTypeUtils.APPLICATION_OCTET;
        string headers = GetHeaders(statusCode, data.Length, _mime, customHeaders);
        byte[] headersBytes = Encoding.UTF8.GetBytes(headers);
        byte[] responseBytes = new byte[data.Length + headersBytes.Length];
 
        headersBytes.CopyTo(responseBytes, 0);
        data.CopyTo(responseBytes, headersBytes.Length);
 
        Send(responseBytes);
 
        //clear memory after sending
        data = [];
        headersBytes = [];
        responseBytes = [];
    }

SendHTMLContent()

void HSB.Response.SendHTMLContent	(	string	content,
		bool	process = false,
		int	statusCode = HTTP_CODES::OK,
		string	encoding = "UTF-8",
		Dictionary< string, string >?	customHeaders = null
	)

Sends an html page passed as string.

Parameters

path	HTML content
process	Whether or not or not process the document before sending
statusCode	Response status code
encoding	Encoding of the document
customHeaders	Optional headers

Definition at line 110 of file Response.cs.

    {
        if (process)
            content = ProcessContent(content);
        Send(content, MimeTypeUtils.TEXT_HTML + $"; charset={encoding}", statusCode, customHeaders);
    }

SendHTMLFile()

void HSB.Response.SendHTMLFile	(	string	path,
		bool	process = false,
		Dictionary< string, string >?	customHeaders = null
	)

Loads and HTML file from path and sends it as HTTP Response with mimeType = text/html Optionally it can provides a basic processor function.

Parameters

path	Path of the HTML file
process	Whether or not or not process the document before sending

Definition at line 82 of file Response.cs.

    {
        try
        {
            string content = File.ReadAllText(path);
            if (process)
                content = ProcessContent(content);
            Encoding encoding = Utils.GetEncoding(path);
 
            Send(content, MimeTypeUtils.TEXT_HTML + $"; charset={encoding.BodyName}", customHeaders: customHeaders);
 
            content = "";
        }
        catch (Exception)
        {
            //dato che l'invio dei dati è parte nostra, se non riusciamo diamo un errore 500
            SendCode(HTTP_CODES.INTERNAL_SERVER_ERROR);
            Terminal.ERROR("Error sending file : " + path);
        }
    }

SendJSON< T >() [1/2]

void HSB.Response.SendJSON< T >	(	T	o,
		bool	includeFields = true
	)

Alternate name for function JSON.

Template Parameters

T

Parameters

o
options

summary> Alternate name for function JSON

Parameters

content

SendJSON< T >() [2/2]

void HSB.Response.SendJSON< T >	(	T	o,
		JsonSerializerOptions	options
	)

Alternate name for function JSON.

Template Parameters

T

Parameters

o
options

SendObject()

void HSB.Response.SendObject	(	object	obj,
		string	fileName = ""
	)

Sends a generic object to the client, with possible optimization (string, byte[], FilePart, generic object)

Parameters

obj
fileName

Definition at line 168 of file Response.cs.

    {
        if (obj == null) return;
 
        if (obj is string str)
            if (fileName != "")
                Send(str, MimeTypeUtils.GetMimeType(Path.GetExtension(fileName)) ?? MimeTypeUtils.TEXT_PLAIN);
            else
                Send(str);
        else if (obj is byte[] bytes)
            Send(bytes);
        else if (obj is FilePart filePart)
            SendFile(filePart);
        else
            SendJSON(obj);
    }

---

The documentation for this class was generated from the following file:

• HSB/Components/Response.cs