live

package

v0.0.0-...-ae8ac80 Latest Latest Go to latest Published: Jun 22, 2022 License: MPL-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/winsock/gochat

Links

Open Source Insights

README ¶

Realtime Communications

This package implements the functionality needed to support realtime chat operations. This happens over a websocket connection that is initiated on the /live endpoint. An example client that connects and displays chat messages in realtime is provided in the `/demoLiveClient directory.

Known Limitations

Sending messages from the live client WIP
Restricted to a single connection per user. In the real world this would need to support multiple connections from the same user.

TODO

Unit testing

Documentation ¶

Index ¶

Variables
type Client
- func Open(server *Server, user database.User, serverCtx context.Context, ...) (*Client, error)
- func (client *Client) Close()
- func (client *Client) SendMessage(message database.Message) error
type ClientFunc
type Server
- func Create(db *database.Database) *Server
- func (server *Server) RunWithClient(userUUID uuid.UUID, clientFunc ClientFunc) error
- func (server *Server) ServeWebsocket(w http.ResponseWriter, r *http.Request)

Constants ¶

This section is empty.

Variables ¶

View Source

var NoSuchClientErr = errors.New("no such client is connected")

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

func Open ¶

func Open(server *Server, user database.User, serverCtx context.Context, w http.ResponseWriter, r *http.Request, onDisconnect ClientFunc) (*Client, error)

func (*Client) Close ¶

func (client *Client) Close()

func (*Client) SendMessage ¶

func (client *Client) SendMessage(message database.Message) error

type ClientFunc ¶

type ClientFunc func(client *Client) error

type Server ¶

type Server struct {
	// contains filtered or unexported fields
}

func Create ¶

func Create(db *database.Database) *Server

func (*Server) RunWithClient ¶

func (server *Server) RunWithClient(userUUID uuid.UUID, clientFunc ClientFunc) error

RunWithClient - Runs a function with a connected client protected by the client mutex

func (*Server) ServeWebsocket ¶

func (server *Server) ServeWebsocket(w http.ResponseWriter, r *http.Request)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL