Skip to content

[WIP] Go library for building a socket server and client, featuring middleware support, channels, handler funcs and re-connects.

License

Notifications You must be signed in to change notification settings

theflyingcodr/sockets

Repository files navigation

sockets

Channel based socket library on top of gorilla/sockets giving listeners, middleware, server and clients.

Release Build Status CodeQL Status Report codecov Go

Table of Contents

Installation

sockets requires a supported release of Go.

go get -u github.com/theflyingcodr/sockets

Documentation

View the generated documentation

GoDoc

For more information around the technical aspects of Bitcoin, please see the updated Bitcoin Wiki

Features

  • Client / Server implementations
  • Middleware
  • Error handlers
  • Listener funcs
  • Channel based messaging
  • Client reconnects
  • Broadcasting directly from server to client or to entire channel
Library Deployment

goreleaser for easy binary or library deployment to Github and can be installed via: brew install goreleaser.

The .goreleaser.yml file is used to configure goreleaser.

Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.

Examples & Tests

All unit tests and examples run via Github Actions and uses Go version 1.17.x. View the configuration file.

Run all tests

make pre-commit

Usage

View the examples


Maintainers

JH
MS

Contributing

View the contributing guidelines and please follow the code of conduct.

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬. You can also support this project by becoming a sponsor on GitHub 👏


License

License

About

[WIP] Go library for building a socket server and client, featuring middleware support, channels, handler funcs and re-connects.

Topics

Resources

License

Stars

Watchers

Forks