Documentation
¶
Index ¶
- Variables
- type CMDDisconnectMessage
- type CMDMessage
- type CapabilityAccessHandle
- type EasyWsBuilder
- type EasyWsCapability
- func (c *EasyWsCapability) Close() error
- func (c *EasyWsCapability) Execute(ctx xcapability.CapExecContext) (any, error)
- func (c *EasyWsCapability) Handle(ctx *gin.Context)
- func (c *EasyWsCapability) ListActions() ([]string, error)
- func (c *EasyWsCapability) Reload(model *dbmodels.SpaceCapability) (xcapability.Capability, error)
- type MessageParams
- type SubscribeParams
Constants ¶
This section is empty.
Variables ¶
View Source
var ( Name = "xEasyWS" Icon = `<i class="fa-solid fa-hexagon-nodes"></i>` OptionFields = []xcapability.CapabilityOptionField{ { Name: "on_connect_action", Key: "on_connect_action", Type: "boolean", }, { Name: "on_disconnect_action", Key: "on_disconnect_action", Type: "boolean", }, { Name: "on_command_action", Key: "on_command_action", Type: "boolean", }, } )
View Source
var ErrInvalidToken = errors.New("invalid token")
View Source
var Ok = struct { Success bool `json:"success"` }{ Success: true, }
Functions ¶
This section is empty.
Types ¶
type CMDDisconnectMessage ¶
type CMDDisconnectMessage struct {
// contains filtered or unexported fields
}
type CMDMessage ¶
type CMDMessage struct {
// contains filtered or unexported fields
}
type CapabilityAccessHandle ¶
type CapabilityAccessHandle interface {
ParseToken(token string) (*signer.CapabilityClaim, error)
EmitActionEvent(opts *xtypes.ActionEventOptions) error
}
type EasyWsBuilder ¶
type EasyWsBuilder struct {
// contains filtered or unexported fields
}
func (*EasyWsBuilder) Build ¶
func (b *EasyWsBuilder) Build(handle xcapability.XCapabilityHandle) (xcapability.Capability, error)
func (*EasyWsBuilder) GetDebugData ¶
func (b *EasyWsBuilder) GetDebugData() map[string]any
func (*EasyWsBuilder) Name ¶
func (b *EasyWsBuilder) Name() string
func (*EasyWsBuilder) Serve ¶
func (b *EasyWsBuilder) Serve(ctx *gin.Context)
type EasyWsCapability ¶
type EasyWsCapability struct {
// contains filtered or unexported fields
}
func (*EasyWsCapability) Close ¶
func (c *EasyWsCapability) Close() error
func (*EasyWsCapability) Execute ¶
func (c *EasyWsCapability) Execute(ctx xcapability.CapExecContext) (any, error)
func (*EasyWsCapability) Handle ¶
func (c *EasyWsCapability) Handle(ctx *gin.Context)
func (*EasyWsCapability) ListActions ¶
func (c *EasyWsCapability) ListActions() ([]string, error)
func (*EasyWsCapability) Reload ¶
func (c *EasyWsCapability) Reload(model *dbmodels.SpaceCapability) (xcapability.Capability, error)
type MessageParams ¶
type MessageParams struct {
ToConnId string `json:"to_cid"`
Topic string `json:"topic"`
Message json.RawMessage `json:"message"`
}
type SubscribeParams ¶
Click to show internal directories.
Click to hide internal directories.