PeanutButter
Loading...
Searching...
No Matches
PeanutButter.SimpleHTTPServer.IHttpServerBase Interface Reference

Describes the base functionality in a simple http-server. More...

Inheritance diagram for PeanutButter.SimpleHTTPServer.IHttpServerBase:
PeanutButter.SimpleHTTPServer.HttpServerBase PeanutButter.SimpleHTTPServer.IHttpServer PeanutButter.SimpleHTTPServer.HttpServer PeanutButter.SimpleHTTPServer.HttpServer

Public Member Functions

void HandleRequestWithoutBody (HttpProcessor p, string method)
 Handles a request that does not contain a body (as of the HTTP spec).
void HandleRequestWithBody (HttpProcessor p, MemoryStream inputData, string method)
 Handles a general request with a request body.
string GetFullUrlFor (string relativeUrl)
 Resolves the full url to the provided path on the current server.
void Start ()
 Start the server.
void Stop ()
 Stop the server.

Properties

Action< RequestLogItemRequestLogAction [get, set]
 Log action used for requests.
string BaseUrl [get]
 Provides the base url from which the server serves.
bool Disposed [get]
 Flag: when true, this server has been disposed.
int MaxShutDownTime [get, set]
 Maximum time, in milliseconds, to wait on the listener task when shutting down.
bool LogRandomPortDiscovery [get, set]
 Whether or not to log random port discovery processes.
Action< string > LogAction [get, set]
 Action to employ when logging (defaults to logging to the console)
int Port [get]
 Port which this server has bound to.
bool IsListening [get]
 Flag exposing listening state.
HttpVersion Version [get, set]
 HTTP version reported by the server in responses Note that this does not change behavior of the server, only the exact format of the response.

Detailed Description

Describes the base functionality in a simple http-server.

Member Function Documentation

◆ GetFullUrlFor()

string PeanutButter.SimpleHTTPServer.IHttpServerBase.GetFullUrlFor ( string relativeUrl)

Resolves the full url to the provided path on the current server.

Parameters
relativeUrl
Returns

Implemented in PeanutButter.SimpleHTTPServer.HttpServerBase.

◆ HandleRequestWithBody()

void PeanutButter.SimpleHTTPServer.IHttpServerBase.HandleRequestWithBody ( HttpProcessor p,
MemoryStream inputData,
string method )

Handles a general request with a request body.

Parameters
pThe HTTP processor.
inputDataThe stream to read the request body from.
methodThe HTTP method.

Implemented in PeanutButter.SimpleHTTPServer.HttpServer, and PeanutButter.SimpleHTTPServer.HttpServerBase.

◆ HandleRequestWithoutBody()

void PeanutButter.SimpleHTTPServer.IHttpServerBase.HandleRequestWithoutBody ( HttpProcessor p,
string method )

Handles a request that does not contain a body (as of the HTTP spec).

Parameters
pThe HTTP processor.
methodThe HTTP method.

Implemented in PeanutButter.SimpleHTTPServer.HttpServer, and PeanutButter.SimpleHTTPServer.HttpServerBase.

Property Documentation

◆ BaseUrl

string PeanutButter.SimpleHTTPServer.IHttpServerBase.BaseUrl
get

Provides the base url from which the server serves.

Implemented in PeanutButter.SimpleHTTPServer.HttpServerBase.

◆ RequestLogAction

Action<RequestLogItem> PeanutButter.SimpleHTTPServer.IHttpServerBase.RequestLogAction
getset

Log action used for requests.

Implemented in PeanutButter.SimpleHTTPServer.HttpServerBase.

◆ Version

HttpVersion PeanutButter.SimpleHTTPServer.IHttpServerBase.Version
getset

HTTP version reported by the server in responses Note that this does not change behavior of the server, only the exact format of the response.

Implemented in PeanutButter.SimpleHTTPServer.HttpServerBase.


The documentation for this interface was generated from the following file:
  • source/SimpleServers/PeanutButter.SimpleHTTPServer/HttpServerBase.cs