websocket

package

v0.20.0 Latest Latest Go to latest Published: Apr 23, 2024 License: Apache-2.0 Imports: 14 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/rulego/rulego

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const Type = "ws"

Type 组件类型

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	Server      string
	CertFile    string
	CertKeyFile string
}

Config Websocket 服务配置

type Endpoint ¶

type Endpoint = Websocket

Endpoint 别名

type RequestMessage ¶

type RequestMessage struct {

	//路径参数
	Params httprouter.Params
	// contains filtered or unexported fields
}

RequestMessage websocket请求消息

func (*RequestMessage) Body ¶

func (r *RequestMessage) Body() []byte

func (RequestMessage) From ¶

func (r RequestMessage) From() string

func (*RequestMessage) GetError ¶

func (r *RequestMessage) GetError() error

func (*RequestMessage) GetMsg ¶

func (r *RequestMessage) GetMsg() *types.RuleMsg

func (*RequestMessage) GetParam ¶

func (r *RequestMessage) GetParam(key string) string

func (*RequestMessage) Headers ¶

func (r *RequestMessage) Headers() textproto.MIMEHeader

func (*RequestMessage) Request ¶

func (r *RequestMessage) Request() *http.Request

func (*RequestMessage) SetBody ¶

func (r *RequestMessage) SetBody(body []byte)

func (*RequestMessage) SetError ¶

func (r *RequestMessage) SetError(err error)

func (*RequestMessage) SetMsg ¶

func (r *RequestMessage) SetMsg(msg *types.RuleMsg)

func (*RequestMessage) SetStatusCode ¶

func (r *RequestMessage) SetStatusCode(statusCode int)

type ResponseMessage ¶

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

ResponseMessage websocket响应消息

func (*ResponseMessage) Body ¶

func (r *ResponseMessage) Body() []byte

func (*ResponseMessage) From ¶

func (r *ResponseMessage) From() string

func (*ResponseMessage) GetError ¶

func (r *ResponseMessage) GetError() error

func (*ResponseMessage) GetMsg ¶

func (r *ResponseMessage) GetMsg() *types.RuleMsg

func (*ResponseMessage) GetParam ¶

func (r *ResponseMessage) GetParam(key string) string

func (*ResponseMessage) Headers ¶

func (r *ResponseMessage) Headers() textproto.MIMEHeader

func (*ResponseMessage) SetBody ¶

func (r *ResponseMessage) SetBody(body []byte)

func (*ResponseMessage) SetError ¶

func (r *ResponseMessage) SetError(err error)

func (*ResponseMessage) SetMsg ¶

func (r *ResponseMessage) SetMsg(msg *types.RuleMsg)

func (*ResponseMessage) SetStatusCode ¶

func (r *ResponseMessage) SetStatusCode(statusCode int)

SetStatusCode 不提供设置状态码

type Websocket ¶

type Websocket struct {
	endpoint.BaseEndpoint
	//配置
	Config       Config
	RuleConfig   types.Config
	OnEventFunc  endpoint.OnEvent
	RestEndpoint *rest.Rest
	Upgrader     websocket.Upgrader
	// contains filtered or unexported fields
}

Websocket 接收端端点

func (*Websocket) AddRouter ¶

func (ws *Websocket) AddRouter(router *endpoint.Router, params ...interface{}) (string, error)

func (*Websocket) Close ¶

func (ws *Websocket) Close() error

func (*Websocket) Destroy ¶

func (ws *Websocket) Destroy()

Destroy 销毁

func (*Websocket) Id ¶

func (ws *Websocket) Id() string

func (*Websocket) Init ¶

func (ws *Websocket) Init(ruleConfig types.Config, configuration types.Configuration) error

Init 初始化

func (*Websocket) New ¶

func (ws *Websocket) New() types.Node

func (*Websocket) Printf ¶

func (ws *Websocket) Printf(format string, v ...interface{})

func (*Websocket) RemoveRouter ¶

func (ws *Websocket) RemoveRouter(routerId string, params ...interface{}) error

func (*Websocket) Router ¶

func (ws *Websocket) Router() *httprouter.Router

func (*Websocket) Start ¶

func (ws *Websocket) Start() error

func (*Websocket) Type ¶

func (ws *Websocket) Type() string

Type 组件类型

Source Files ¶

View all Source files

websocket.go

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