ikisocket

package module

v0.0.0-...-b7f01d1 Latest Latest Go to latest Published: Feb 18, 2024 License: MIT Imports: 7 Imported by: 14

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/antoniodipinto/ikisocket

Links

Open Source Insights

README ¶

Last update

Here's What's Happening

This repository has moved to a new URL, directly under Fiber's Contrib Repo. This move is part of my effort to enhance the project and offer you better features and support.

Here: https://github.com/gofiber/contrib/blob/main/socketio/README.md

Important note, the name has now changed from ikisocket to Socket.IO

If you wish to switch directly to the new repository, ensure you update your code accordingly.

From this:

import (
    "github.com/antoniodipinto/ikisocket"
    "github.com/gofiber/contrib/websocket"
    "github.com/gofiber/fiber/v2"
)

ikisocket.On("EVENT_NAME", func(ep *ikisocket.EventPayload) {})

ikisocket.New(func(kws *ikisocket.Websocket){})

To this

import (
    "github.com/gofiber/contrib/socketio"
    "github.com/gofiber/contrib/websocket"
    "github.com/gofiber/fiber/v2"
)

socketio.On("EVENT_NAME", func(ep *socketio.EventPayload) {})

socketio.New(func(kws *socketio.Websocket){})

Quick Notes:

Bookmark the new repo: Make sure to star the new repository to keep up with updates.
Future Contributions: Please direct all new issues and contributions to the new repo.
Continuous Support: Your feedback and contributions are always highly appreciated.

WebSocket wrapper for Fiber v2 with events support

Based on Fiber Websocket and inspired by Socket.io

Star History

Documentation ¶

Index ¶

Constants
Variables
func Broadcast(message []byte, mType ...int)
func EmitTo(uuid string, message []byte, mType ...int) error
func EmitToList(uuids []string, message []byte, mType ...int)
func Fire(event string, data []byte)
func New(callback func(kws *Websocket)) func(*fiber.Ctx) error
func On(event string, callback eventCallback)
type EventPayload
type Websocket

Constants ¶

View Source

const (
	// TextMessage denotes a text data message. The text message payload is
	// interpreted as UTF-8 encoded text data.
	TextMessage = 1
	// BinaryMessage denotes a binary data message.
	BinaryMessage = 2
	// CloseMessage denotes a close control message. The optional message
	// payload contains a numeric code and text. Use the FormatCloseMessage
	// function to format a close message payload.
	CloseMessage = 8
	// PingMessage denotes a ping control message. The optional message payload
	// is UTF-8 encoded text.
	PingMessage = 9
	// PongMessage denotes a pong control message. The optional message payload
	// is UTF-8 encoded text.
	PongMessage = 10
)

Source @url:https://github.com/gorilla/websocket/blob/master/conn.go#L61 The message types are defined in RFC 6455, section 11.8.

View Source

const (
	// EventMessage Fired when a Text/Binary message is received
	EventMessage = "message"
	// EventPing More details here:
	// @url https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_servers#Pings_and_Pongs_The_Heartbeat_of_WebSockets
	EventPing = "ping"
	EventPong = "pong"
	// EventDisconnect Fired on disconnection
	// The error provided in disconnection event
	// is defined in RFC 6455, section 11.7.
	// @url https://github.com/gofiber/websocket/blob/cd4720c435de415b864d975a9ca23a47eaf081ef/websocket.go#L192
	EventDisconnect = "disconnect"
	// EventConnect Fired on first connection
	EventConnect = "connect"
	// EventClose Fired when the connection is actively closed from the server
	EventClose = "close"
	// EventError Fired when some error appears useful also for debugging websockets
	EventError = "error"
)

Supported event list

Variables ¶

View Source

var (
	// ErrorInvalidConnection The addressed Conn connection is not available anymore
	// error data is the uuid of that connection
	ErrorInvalidConnection = errors.New("message cannot be delivered invalid/gone connection")
	// ErrorUUIDDuplication The UUID already exists in the pool
	ErrorUUIDDuplication = errors.New("UUID already exists in the available connections pool")
)

View Source

var (
	PongTimeout = 1 * time.Second
	// RetrySendTimeout retry after 20 ms if there is an error
	RetrySendTimeout = 20 * time.Millisecond
	//MaxSendRetry define max retries if there are socket issues
	MaxSendRetry = 5
	// ReadTimeout Instead of reading in a for loop, try to avoid full CPU load taking some pause
	ReadTimeout = 10 * time.Millisecond
)

Functions ¶

func Broadcast ¶

func Broadcast(message []byte, mType ...int)

Broadcast to all the active connections

func EmitTo ¶

func EmitTo(uuid string, message []byte, mType ...int) error

EmitTo Emit to a specific socket connection

func EmitToList ¶

func EmitToList(uuids []string, message []byte, mType ...int)

EmitToList Emit the message to a specific socket uuids list Ignores all errors

func Fire ¶

func Fire(event string, data []byte)

Fire custom event on all connections

func New ¶

func New(callback func(kws *Websocket)) func(*fiber.Ctx) error

func On ¶

func On(event string, callback eventCallback)

On Add listener callback for an event into the listeners list

Types ¶

type EventPayload ¶

type EventPayload struct {
	// The connection object
	Kws *Websocket
	// The name of the event
	Name string
	// Unique connection UUID
	SocketUUID string
	// Optional websocket attributes
	SocketAttributes map[string]interface{}
	// Optional error when are fired events like
	// - Disconnect
	// - Error
	Error error
	// Data is used on Message and on Error event
	Data []byte
}

EventPayload Event Payload is the object that stores all the information about the event and the connection

type Websocket ¶

type Websocket struct {

	// The Fiber.Websocket connection
	Conn *websocket.Conn

	// Unique id of the connection
	UUID string
	// Wrap Fiber Locals function
	Locals func(key string) interface{}
	// Wrap Fiber Params function
	Params func(key string, defaultValue ...string) string
	// Wrap Fiber Query function
	Query func(key string, defaultValue ...string) string
	// Wrap Fiber Cookies function
	Cookies func(key string, defaultValue ...string) string
	// contains filtered or unexported fields
}

func (*Websocket) Broadcast ¶

func (kws *Websocket) Broadcast(message []byte, except bool, mType ...int)

Broadcast to all the active connections except avoid broadcasting the message to itself

func (*Websocket) Close ¶

func (kws *Websocket) Close()

Close Actively close the connection from the server

func (*Websocket) Emit ¶

func (kws *Websocket) Emit(message []byte, mType ...int)

Emit /Write the message into the given connection

func (*Websocket) EmitTo ¶

func (kws *Websocket) EmitTo(uuid string, message []byte, mType ...int) error

EmitTo Emit to a specific socket connection

func (*Websocket) EmitToList ¶

func (kws *Websocket) EmitToList(uuids []string, message []byte, mType ...int)

EmitToList Emit the message to a specific socket uuids list

func (*Websocket) Fire ¶

func (kws *Websocket) Fire(event string, data []byte)

Fire custom event

func (*Websocket) GetAttribute ¶

func (kws *Websocket) GetAttribute(key string) interface{}

GetAttribute Get a specific attribute from the socket attributes

func (*Websocket) GetIntAttribute ¶

func (kws *Websocket) GetIntAttribute(key string) int

GetIntAttribute Convenience method to retrieve an attribute as an int. Will panic if attribute is not an int.

func (*Websocket) GetStringAttribute ¶

func (kws *Websocket) GetStringAttribute(key string) string

GetStringAttribute Convenience method to retrieve an attribute as a string. Will panic if attribute is not an int.

func (*Websocket) GetUUID ¶

func (kws *Websocket) GetUUID() string

func (*Websocket) IsAlive ¶

func (kws *Websocket) IsAlive() bool

func (*Websocket) SetAttribute ¶

func (kws *Websocket) SetAttribute(key string, attribute interface{})

SetAttribute Set a specific attribute for the specific socket connection

func (*Websocket) SetUUID ¶

func (kws *Websocket) SetUUID(uuid string)

Source Files ¶

View all Source files

ikisocket.go

Directories ¶

Path	Synopsis
examples
chat_example
chat_room_example
custom_event_example

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