Skip to content

Commit

Permalink
fix readme links, fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
CypherPotato committed Feb 16, 2024
1 parent c25dd15 commit 5b95ab1
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 9 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
</p>
<h1>Sisk Framework</h1>

[Discover Sisk](https://sisk.project-principium.dev/) | [Documentation](https://sisk.project-principium.dev/read?q=/contents/docs/welcome.md) | [Changelog](https://github.com/sisk-http/docs/blob/master/Changelog.md) | [Specification](https://sisk.project-principium.dev/read?q=/contents/spec/index.md) | [Benchmark](https://github.com/sisk-http/benchmarks) | [Roadmap](https://github.com/orgs/sisk-http/projects/1)
[Discover Sisk](https://sisk.project-principium.dev/) | [Documentation](https://md.proj.pw/sisk-http/docs-v2/main) | [Changelogs](https://github.com/sisk-http/archive/tree/master/changelogs) | [Benchmarks](https://github.com/sisk-http/benchmarks)

<div>

Expand All @@ -17,16 +17,14 @@

**Sisk** is a **web development framework** that is lightweight, agnostic, easy, simple, and robust. The perfect choice for your next project.

**You can do more with less.**

</div>

------


### Documentation

You can get started with Sisk [here](https://sisk.project-principium.dev/read?q=/contents/docs/getting-started.md) or build the documentation repository [here](https://github.com/sisk-http/docs).
You can get started with Sisk [here](https://md.proj.pw/sisk-http/docs-v2/main/) or build the documentation repository [here](https://github.com/sisk-http/docs-v2).

For information about release notes, changelogs and API breaking changes, see [docs/Changelog.md](https://github.com/sisk-http/docs/blob/master/Changelog.md).

Expand All @@ -43,7 +41,7 @@ PM> NuGet\Install-Package Sisk.HttpServer
In this repository, you have the source code of:

- [Sisk.HttpServer](src): the Sisk Framework mainframe and core functions.
- [Sisk.ServiceProvider](extensions/Sisk.ServiceProvider): the Service Providers utility package for porting your Sisk app between environments. This package is indeed to work with version 0.15 and olders, as [0.16 has it implemented on it's [core package](https://github.com/sisk-http/docs/blob/master/archive/0.16/service-providers-migration.md).
- [Sisk.ServiceProvider](extensions/Sisk.ServiceProvider): (legacy) the Service Providers utility package for porting your Sisk app between environments. This package is indeed to work with version 0.15 and olders, as 0.16 has it implemented on it's [core package](https://github.com/sisk-http/docs/blob/master/archive/0.16/service-providers-migration.md).
- [Sisk.BasicAuth](extensions/Sisk.BasicAuth): the basic authentication package which provides helper request handlers for handling authentication.

## Getting started
Expand Down Expand Up @@ -89,4 +87,4 @@ Sisk can do web development the way you want. Create MVC, MVVC, SOLID applicatio

Sisk is a highly modular and sustainable framework designed for creating a variety of applications, including Restful applications, gRPC, Websockets, file servers, GraphQL, Entity Framework, and more. Its development is ongoing, with a focus on simplicity, easy maintenance, and an enjoyable experience for developers. Sisk is known for its efficiency, even in low-performance environments, and it can handle over twenty thousand requests per second. The framework is compatible with any machine supporting .NET, including those that do not require Native AOT. Sisk also offers additional implementations and packages for extended functionality.

While Sisk draws inspiration from ASP.NET, it aims for simpler and more performant development without the need for installing additional components. It provides a straightforward and robust development model, allowing developers to handle requests efficiently and explicitly. Sisk simplifies HTTP-related tasks and offers comprehensive documentation and open-source access to its source code, making it accessible and easy to learn for web developers.
While Sisk draws inspiration from ASP.NET, it aims for simpler and more performant development without the need for installing additional components. It provides a straightforward and robust development model, allowing developers to handle requests efficiently and explicitly. Sisk simplifies HTTP-related tasks and offers comprehensive documentation and open-source access to its source code, making it accessible and easy to learn for web developers.
7 changes: 6 additions & 1 deletion src/Http/Hosting/HttpServerHostContext.cs
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,12 @@ public void Start(bool verbose = true, bool preventHault = true)
HttpServer.Start();

if (verbose)
Console.WriteLine(SR.Httpserver_StartMessage, HttpServer.ListeningPrefixes[0]);
{
Console.WriteLine(SR.Httpserver_StartMessage);
foreach (string prefix in HttpServer.ListeningPrefixes)
Console.WriteLine("- {0}", prefix);
}

if (preventHault)
Thread.Sleep(-1);
}
Expand Down
14 changes: 14 additions & 0 deletions src/Http/HttpContextBagRepository.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,20 @@ public class HttpContextBagRepository : IDictionary<string, object?>
private static string GetTypeKeyName(Type t) =>
t.Name + "+" + t.GetHashCode();

/// <summary>
/// Creates an new instance of the <see cref="HttpContextBagRepository"/> class.
/// </summary>
/// <definition>
/// public HttpContextBagRepository()
/// </definition>
/// <type>
/// Constructor
/// </type>
public HttpContextBagRepository()
{

}

/// <summary>
/// Gets or sets an bag item by it's key.
/// </summary>
Expand Down
14 changes: 14 additions & 0 deletions src/Http/HttpRequest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,20 @@ public string Host
get => listenerRequest.Url!.Host;
}

/// <summary>
/// Gets the managed object which holds data for an entire HTTP session.
/// </summary>
/// <remarks>
/// This property is an shortcut for <see cref="HttpContext.RequestBag"/> property.
/// </remarks>
/// <definition>
/// public HttpContextBagRepository Bag { get; }
/// </definition>
/// <type>
/// Property
/// </type>
public HttpContextBagRepository Bag { get => Context.RequestBag; }

/// <summary>
/// Get the requested host header with the port from this HTTP request.
/// </summary>
Expand Down
2 changes: 1 addition & 1 deletion src/Internal/SR.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ static class SR
public const string HttpResponse_Redirect_NotMatchGet = "The specified method does not handle GET requests.";

public const string Httpserver_NoListeningHost = "Cannot start the HTTP server with no listening hosts.";
public const string Httpserver_StartMessage = "The HTTP server is listening at {0}";
public const string Httpserver_StartMessage = "The HTTP server is listening at:";
public const string Httpserver_Commons_HeaderAfterContents = "Cannot send headers or status code after sending response contents.";
public const string Httpserver_Commons_RouterTimeout = "Request maximum execution time exceeded it's limit.";

Expand Down
2 changes: 1 addition & 1 deletion src/Routing/Router__CoreInvoker.cs
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ internal async Task<RouterExecutionResult> Execute(HttpContext context)

HttpServerFlags flag = ParentServer!.ServerConfiguration.Flags;
bool hasGlobalHandlers = this.GlobalRequestHandlers?.Length > 0;

foreach (Route route in _routes)
{
// test path
Expand Down

0 comments on commit 5b95ab1

Please sign in to comment.