ws

package

v1.4.2 Latest Latest Go to latest Published: Sep 24, 2022 License: MIT Imports: 6 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/camphor-/relaym-server

Links

Open Source Insights

Documentation ¶

Index ¶

type Client
- func NewClient(sessionID string, ws *websocket.Conn, notifyClosedCh chan<- *Client) *Client
- func (c *Client) PushLoop()
- func (c *Client) ReadLoop()
type Hub
- func NewHub() *Hub

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

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

Client はWebSocketのクライアントを表します。

func NewClient ¶

func NewClient(sessionID string, ws *websocket.Conn, notifyClosedCh chan<- *Client) *Client

NewClient は Clientのポインタを生成します。

func (*Client) PushLoop ¶

func (c *Client) PushLoop()

PushLoop は一つのWebSocketコネクションに対してメッセージを送信するループです。一つのWebSocketコネクションに対して一つのgoroutineでPushLoop()が実行されます。接続が切れた場合はnotifyClosedChを通じてHubに登録されているwsConnを削除してメモリリークを防ぎます。

func (*Client) ReadLoop ¶

func (c *Client) ReadLoop()

ReadLoop はクライアントからのメッセージを受け取るループです。今回はサーバからイベントを送信するのみですが、Pingのやりとりに必要なのでループを回してます。

type Hub ¶

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

Hub はすべてのWebSocketクライアント一元管理する構造体です。プロセス内に実体は一つしか存在しません。

func NewHub ¶

func NewHub() *Hub

NewHub はHubのポインタを生成します。

func (*Hub) Push ¶

func (h *Hub) Push(pushMsg *event.PushMessage)

Push はpushMsgをチャネルに流して、接続されているクライアントに送信します。 event.Pusher インターフェースを満たしています。

func (*Hub) Register ¶

func (h *Hub) Register(client *Client)

Register は新しいWebSocketのクライアントをHubに登録します。スレッドセーフになるようにチャネルを通じて登録されます。実際の作業は Run() で行われます。

func (*Hub) Run ¶

func (h *Hub) Run()

Run はWebSocketのメッセージを送信するメインループを実行する関数です。

func (*Hub) Unregister ¶

func (h *Hub) Unregister(client *Client)

Unregister はWebSocketのクライアントをHubから登録解除します。スレッドセーフになるようにチャネルを通じて登録解除されます。実際の作業は Run() で行われます。

func (*Hub) UnregisterCh ¶

func (h *Hub) UnregisterCh() chan<- *Client

UnregisterCh は送信専用のクライアント登録解除のチャネルを返します。

Source Files ¶

View all Source files

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