README
¶
Client Package
The client package represents a single active WebSocket connection to the server. It is responsible for sending and receiving messages on behalf of a user and acts as the communication bridge between the frontend and the hub.
Architecture
Responsibilities
- Manage the lifecycle of an individual WebSocket connection.
- Read and deserialize incoming messages from the client.
- Send messages asynchronously via a buffered channel.
- Pass valid messages to the hub for routing and broadcasting.
- Identify the source client type using OAuth client ID (e.g.,
ChatClient,WebClient). - Track connection timestamps for session analytics.
Key Struct
Client:Username: user-visible name.Sub: stable unique identifier (from OAuth provider).ClientID: identifies the type of application used (admin dashboard, chat UI, etc.).Conn: the active WebSocket connection.Send: channel for outgoing messages.Hub: reference to the centralHubInterface.ConnectedAt: timestamp of connection start.
🔁 Workflow
-
Connection Setup:
- A
Clientis created with an active WebSocket connection and registered with the hub.
- A
-
Message Receiving (ReadPump):
- Runs in a goroutine.
- Listens for JSON messages from the WebSocket.
- Deserializes into a lightweight struct.
- Constructs appropriate
BaseMessageobjects based on message type. - Sends the message to the hub for processing.
-
Message Sending (WritePump):
- Also runs in a goroutine.
- Listens on the
Sendchannel. - Encodes
BaseMessageas JSON and writes it to the WebSocket. - Handles cleanup on failure or disconnect.
-
Disconnection:
- Triggers unregistration from the hub.
- Closes the connection and the send channel.
Usage Example
client := &Client{
Username: "alice",
Sub: "user-alice-123",
ClientID: "ChatClient",
Conn: conn, // *websocket.Conn
Send: make(chan messages.BaseMessage, 16),
Hub: hub,
}
go client.ReadPump()
go client.WritePump()
hub.Register <- client
📝 TODO
- Optionally support a shutdown message or ping/pong handling to detect dead clients early.
- Add per-client rate-limiting or mute functionality at the client level.
- Log dropped messages if the
Sendchannel is full or unresponsive.
Documentation
¶
Index ¶
- type Client
- func (c *Client) CloseSendChannel()
- func (c *Client) GetClientID() string
- func (c *Client) GetConnectedAt() time.Time
- func (c *Client) GetID() string
- func (c *Client) GetUsername() string
- func (c *Client) ReadPump()
- func (c *Client) SendMessage(msg messages.BaseMessage)
- func (c *Client) StartConnectionTimer()
- func (c *Client) WritePump()
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
Username string
Conn *websocket.Conn
Send chan messages.BaseMessage
Hub interfaces.HubInterface
Sub string // Keycloak stable user ID
ClientID string // OAuth client ID, e.g., "ChatClient" or "WebClient"
ConnectedAt time.Time
}
Client represents a single WebSocket connection from a user. It manages receiving and sending messages to/from the server.
func (*Client) CloseSendChannel ¶
func (c *Client) CloseSendChannel()
CloseSendChannel closes the client's outgoing message channel.
func (*Client) GetClientID ¶
GetClientID returns the OAuth client ID used to identify the source application.
func (*Client) GetConnectedAt ¶
GetConnectedAt returns the timestamp when the client connected.
func (*Client) GetUsername ¶
GetUsername returns the client's username.
func (*Client) ReadPump ¶
func (c *Client) ReadPump()
ReadPump listens for incoming messages from the WebSocket and processes them. Parsed messages are sent to the hub for broadcast or private delivery.
func (*Client) SendMessage ¶
func (c *Client) SendMessage(msg messages.BaseMessage)
SendMessage places a message into the send channel to be picked up by WritePump().
func (*Client) StartConnectionTimer ¶
func (c *Client) StartConnectionTimer()
StartConnectionTimer records the time when the client connects.
Source Files