websocket

package
v1.12.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 6, 2024 License: Apache-2.0 Imports: 3 Imported by: 21

Documentation

Overview

Copyright 2016 Wenhui Shen <www.webx.top>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2016 Wenhui Shen <www.webx.top>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

This section is empty.

Variables

View Source
var (
	DefaultStdUpgrader = &websocket.Upgrader{}
	DefaultExecuter    = func(c *websocket.Conn, ctx echo.Context) (err error) {
		for {
			mt, message, err := c.ReadMessage()
			if err != nil {
				return err
			}
			log.Infof("Websocket recv: %s", message)

			if err = c.WriteMessage(mt, message); err != nil {
				return err
			}
		}
	}
)
View Source
var (
	DefaultUpgrader = &websocket.EchoUpgrader{}
)

Functions

func HanderWrapper

func HanderWrapper(v interface{}) echo.Handler

func StdHanderWrapper

func StdHanderWrapper(v interface{}) echo.Handler

func StdWebsocket

func StdWebsocket(executer func(*websocket.Conn, echo.Context) error, validate func(echo.Context) error, opts ...*websocket.Upgrader) echo.HandlerFunc

func Websocket

func Websocket(executer func(*websocket.Conn, echo.Context) error, validate func(echo.Context) error, opts ...*websocket.EchoUpgrader) echo.HandlerFunc

Types

type Handler

type Handler interface {
	Handle(*websocket.Conn, echo.Context) error
	Upgrader() *websocket.EchoUpgrader
	Validate(echo.Context) error
}

type Options

type Options struct {
	Handle   func(*websocket.Conn, echo.Context) error
	Upgrader *websocket.EchoUpgrader
	Validate func(echo.Context) error
	Prefix   string
}

func New added in v1.6.0

func New(prefix string, handler func(*websocket.Conn, echo.Context) error) *Options

func (*Options) SetHandler added in v1.6.0

func (o *Options) SetHandler(handler func(*websocket.Conn, echo.Context) error) *Options

func (*Options) SetPrefix added in v1.6.0

func (o *Options) SetPrefix(prefix string) *Options

func (*Options) SetUpgrader added in v1.6.0

func (o *Options) SetUpgrader(upgrader *websocket.EchoUpgrader) *Options

func (*Options) SetValidator added in v1.6.0

func (o *Options) SetValidator(validator func(echo.Context) error) *Options

func (Options) Wrapper

func (o Options) Wrapper(e echo.RouteRegister) echo.IRouter

type StdHandler

type StdHandler interface {
	Handle(*websocket.Conn, echo.Context) error
	Upgrader() *websocket.Upgrader
	Validate(echo.Context) error
}

type StdOptions

type StdOptions struct {
	Handle   func(*websocket.Conn, echo.Context) error
	Upgrader *websocket.Upgrader
	Validate func(echo.Context) error
	Prefix   string
}

func NewStd added in v1.6.0

func NewStd(prefix string, handler func(*websocket.Conn, echo.Context) error) *StdOptions

func (*StdOptions) SetHandler added in v1.6.0

func (o *StdOptions) SetHandler(handler func(*websocket.Conn, echo.Context) error) *StdOptions

func (*StdOptions) SetPrefix added in v1.6.0

func (o *StdOptions) SetPrefix(prefix string) *StdOptions

func (*StdOptions) SetUpgrader added in v1.6.0

func (o *StdOptions) SetUpgrader(upgrader *websocket.Upgrader) *StdOptions

func (*StdOptions) SetValidator added in v1.6.0

func (o *StdOptions) SetValidator(validator func(echo.Context) error) *StdOptions

func (StdOptions) Wrapper

func (o StdOptions) Wrapper(e echo.RouteRegister) echo.IRouter

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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