| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
FSharp.Control.WebSockets wraps dotnet websockets in FSharp friendly functions and has a ThreadSafe version.
Dotnet websockets only allow for one receive and one send at a time. If multiple threads try to write to a websocket, it will throw a System.InvalidOperationException with the message There is already one outstanding 'SendAsync' call for this WebSocket instance. ReceiveAsync and SendAsync can be called simultaneously, but at most one outstanding operation for each of them is allowed at the same time.. This wraps a websocket in a FIFO that allows for multiple threads to write or read at the same time. See Websocket Remarks on Microsoft for more information.
This provides a readMessage type function. This is the biggest stumbling block people have when working with websockets. You have to keep reading from the message until it’s finished. People either don’t and end up having corrupted messages with a small buffer or have a buffer that is giant and can be a memory hog for smaller messages.
Uses RecyclableMemoryStreamManager and ArrayPool to help keep memory usage and GC down.
| GitHub Actions |
|---|
| Name | Stable | Prerelease |
|---|---|---|
| FSharp.Control.Websockets | ||
| FSharp.Control.Websockets.TPL |
open System
open System.Net.WebSockets
open System.Threading.Tasks
open Microsoft.AspNetCore.Builder
open Microsoft.AspNetCore.Hosting
open Microsoft.AspNetCore.Http
open FSharp.Control.Websockets
open Microsoft.Extensions.Configuration
let echoWebSocket (httpContext: HttpContext) (next: unit -> Async<unit>) =
async {
if httpContext.WebSockets.IsWebSocketRequest then
let! websocket =
httpContext.WebSockets.AcceptWebSocketAsync()
|> Async.AwaitTask
// Create a thread-safe WebSocket from an existing websocket
let threadSafeWebSocket =
ThreadSafeWebSocket.createFromWebSocket websocket
while threadSafeWebSocket.State = WebSocketState.Open do
try
let! result =
threadSafeWebSocket
|> ThreadSafeWebSocket.receiveMessageAsUTF8
match result with
| Ok (WebSocket.ReceiveUTF8Result.String text) ->
//Echo it back to the client
do! WebSocket.sendMessageAsUTF8 websocket (text)
| Ok (WebSocket.ReceiveUTF8Result.Closed (status, reason)) -> printfn "Socket closed %A - %s" status reason
| Error (ex) -> printfn "Receiving threw an exception %A" ex.SourceException
with e -> printfn "%A" e
else
do! next ()
}
//Convenience function for making middleware with F# asyncs and funcs
let fuse (middlware: HttpContext -> (unit -> Async<unit>) -> Async<unit>) (app: IApplicationBuilder) =
app.Use
(fun env next ->
middlware env (next.Invoke >> Async.AwaitTask)
|> Async.StartAsTask
:> Task)
let configureEchoServer (appBuilder: IApplicationBuilder) =
appBuilder.UseWebSockets()
|> fuse (echoWebSocket)
|> ignore
let getKestrelServer configureServer uri =
let configBuilder = new ConfigurationBuilder()
let configBuilder = configBuilder.AddInMemoryCollection()
let config = configBuilder.Build()
config.["server.urls"] <- uri
let host =
WebHostBuilder()
.UseConfiguration(config)
.UseKestrel()
.Configure(fun app -> configureServer app)
.Build()
.Start()
host
[<EntryPoint>]
let main argv =
getKestrelServer configureEchoServer "http://localhost:3000"
Console.ReadKey() |> ignore
0Make sure the following requirements are installed in your system:
> build.cmd // on windows $ ./build.sh // on unix
The WatchTests target will use dotnet-watch to watch for changes in your lib or tests and re-run your tests on all TargetFrameworks
./build.sh WatchTests
git add . git commit -m "Scaffold" git remote add origin origin https://github.com/user/MyCoolNewLib.git git push -u origin master
paket config add-token "https://www.nuget.org" 4003d786-cc37-4004-bfdf-c4f3e8ef9b3a
Then update the RELEASE_NOTES.md with a new version, date, and release notes ReleaseNotesHelper
#### 0.2.0 - 2017-04-20 * FEATURE: Does cool stuff! * BUGFIX: Fixes that silly oversight
./build.sh Release
To format code run the following target
./build.sh FormatCode
This uses Fantomas to do code formatting. Please report code formatting bugs to that repository.
| Back | FazBrowse Home | New Git URL |