Documentation
¶
Index ¶
- Variables
- func AddCancelChannel() (key string, c chan int)
- func BroadcastSecondaryWebSocketData(data []byte)
- func BroadcastSecondaryWebSocketJSON(v interface{})
- func BroadcastWebSocketData(data []byte)
- func BroadcastWebSocketJSON(v interface{})
- func CancelChannel(key string)
- func CloseAllSecondarySockets()
- func CloseAllSockets()
- func GetAllSecondaryWebSocketMeta() (items *sync.Map)
- func GetAllWebSocketMeta() (items *sync.Map)
- func Initialize(path string, config string) (err error)
- func InitializeLite(secureHeaders bool, allowedHosts []string) (err error)
- func PublishSecondaryWebSocketJSON(key string, v interface{})
- func PublishWebSocketJSON(key string, v interface{})
- func RandomString(strlen int) string
- func RegisterSecondaryWebSocketDataCallback(callback WebSocketCallback)
- func RegisterWebSocketDataCallback(callback WebSocketCallback)
- func RemoveSecondaryWebSocketMeta(id string)
- func RemoveWebSocketMeta(id string)
- func ReplyToWebSocket(conn *WebSocketConnection, data []byte)
- func ReplyToWebSocketJSON(conn *WebSocketConnection, v interface{})
- func ReplyToWebSocketPubSub(conn *WebSocketConnection, key string, v interface{})
- func ReplyToWebSocketSynchronous(conn *WebSocketConnection, data []byte) (err error)
- func Run()
- func RunLite(port int)
- func SetSecondaryWebSocketMeta(id string, info *WebSocketConnectionMeta)
- func SetSecondaryWebSocketTimeout(timeout int)
- func SetWebSocketMeta(id string, info *WebSocketConnectionMeta)
- func SetWebSocketTimeout(timeout int)
- type GinContextSync
- type WebSocketCallback
- type WebSocketConnection
- type WebSocketConnectionMeta
- type WebSocketEventPayload
- type WebSocketPubSubPayload
- type WebSocketRemoval
- type WebSocketUpdateIdPayload
Constants ¶
This section is empty.
Variables ¶
View Source
var BroadcastSockets bool
View Source
var CustomLog customLog
View Source
var WebSocketConnections sync.Map
View Source
var WebSocketSecondaryConnections sync.Map
Functions ¶
func AddCancelChannel ¶
func BroadcastSecondaryWebSocketData ¶ added in v1.3.9
func BroadcastSecondaryWebSocketData(data []byte)
func BroadcastSecondaryWebSocketJSON ¶ added in v1.3.9
func BroadcastSecondaryWebSocketJSON(v interface{})
func BroadcastWebSocketData ¶
func BroadcastWebSocketData(data []byte)
func BroadcastWebSocketJSON ¶
func BroadcastWebSocketJSON(v interface{})
func CancelChannel ¶
func CancelChannel(key string)
func CloseAllSecondarySockets ¶ added in v1.3.9
func CloseAllSecondarySockets()
func CloseAllSockets ¶
func CloseAllSockets()
func GetAllSecondaryWebSocketMeta ¶ added in v1.3.9
func GetAllWebSocketMeta ¶
func Initialize ¶
func InitializeLite ¶
func PublishSecondaryWebSocketJSON ¶ added in v1.3.9
func PublishSecondaryWebSocketJSON(key string, v interface{})
func PublishWebSocketJSON ¶
func PublishWebSocketJSON(key string, v interface{})
func RandomString ¶
func RegisterSecondaryWebSocketDataCallback ¶ added in v1.3.9
func RegisterSecondaryWebSocketDataCallback(callback WebSocketCallback)
func RegisterWebSocketDataCallback ¶
func RegisterWebSocketDataCallback(callback WebSocketCallback)
func RemoveSecondaryWebSocketMeta ¶ added in v1.3.9
func RemoveSecondaryWebSocketMeta(id string)
func RemoveWebSocketMeta ¶
func RemoveWebSocketMeta(id string)
func ReplyToWebSocket ¶
func ReplyToWebSocket(conn *WebSocketConnection, data []byte)
func ReplyToWebSocketJSON ¶
func ReplyToWebSocketJSON(conn *WebSocketConnection, v interface{})
func ReplyToWebSocketPubSub ¶
func ReplyToWebSocketPubSub(conn *WebSocketConnection, key string, v interface{})
func ReplyToWebSocketSynchronous ¶ added in v1.3.9
func ReplyToWebSocketSynchronous(conn *WebSocketConnection, data []byte) (err error)
func SetSecondaryWebSocketMeta ¶ added in v1.3.9
func SetSecondaryWebSocketMeta(id string, info *WebSocketConnectionMeta)
func SetSecondaryWebSocketTimeout ¶ added in v1.3.9
func SetSecondaryWebSocketTimeout(timeout int)
func SetWebSocketMeta ¶
func SetWebSocketMeta(id string, info *WebSocketConnectionMeta)
func SetWebSocketTimeout ¶
func SetWebSocketTimeout(timeout int)
Types ¶
type GinContextSync ¶
type GinContextSync struct {
sync.RWMutex
Initialized atomicTypes.AtomicBool
Context *gin.Context
}
type WebSocketCallback ¶
type WebSocketConnection ¶
type WebSocketConnection struct {
sync.RWMutex
Id string
Connection *websocket.Conn
Req *http.Request
Context interface{}
ContextString string
ContextType string
ContextLock sync.RWMutex
WriteLock sync.RWMutex
LastResponseTime time.Time
LastResponseTimeLock sync.RWMutex
GinContextSync GinContextSync
}
type WebSocketConnectionMeta ¶
type WebSocketConnectionMeta struct {
Conn *WebSocketConnection
Context interface{}
ContextString string
ContextType string
LastResponseTime atomicTypes.AtomicTime
TimeoutOverride atomicTypes.AtomicInt
}
func GetSecondaryWebSocketMeta ¶ added in v1.3.9
func GetSecondaryWebSocketMeta(id string) (info *WebSocketConnectionMeta, ok bool)
func GetWebSocketMeta ¶
func GetWebSocketMeta(id string) (info *WebSocketConnectionMeta, ok bool)
func (*WebSocketConnectionMeta) GetConnection ¶
func (obj *WebSocketConnectionMeta) GetConnection() (conn *WebSocketConnection)
func (*WebSocketConnectionMeta) SetTimeoutOverride ¶
func (obj *WebSocketConnectionMeta) SetTimeoutOverride(timeout int)
type WebSocketEventPayload ¶ added in v1.3.9
type WebSocketPubSubPayload ¶
type WebSocketPubSubPayload struct {
Key string `json:"Key"`
Content interface{} `json:"Content"`
}
type WebSocketRemoval ¶
type WebSocketRemoval func(info WebSocketConnectionMeta)
var WebSocketRemovalCallback WebSocketRemoval
var WebSocketSecondaryRemovalCallback WebSocketRemoval
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.