sockjs

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.

Index

• Variables
• func HanderWrapper(v interface{}) echo.Handler
• func Websocket(prefix string, executer func(sockjs.Session) error, ...) echo.HandlerFunc
• type Handler
• type Options
  • func New(prefix string, handler func(sockjs.Session) error) *Options
  • func (o *Options) SetHandler(handler func(sockjs.Session) error) *Options
  • func (o *Options) SetOptions(options *sockjs.Options) *Options
  • func (o *Options) SetPrefix(prefix string) *Options
  • func (o *Options) SetValidator(validator func(echo.Context) error) *Options
  • func (o Options) Wrapper(e echo.RouteRegister) echo.IRouter

Variables

var DefaultExecuter = func(session sockjs.Session) error {
	for {
		msg, err := session.Recv()
		if err != nil {
			return err
		}
		err = session.Send(msg)
		if err != nil {
			return err
		}
	}
}

Functions

func HanderWrapper

func HanderWrapper(v interface{}) echo.Handler

func Websocket

func Websocket(prefix string, executer func(sockjs.Session) error, validate func(echo.Context) error, opts ...*sockjs.Options) echo.HandlerFunc

Types

type Handler

type Handler interface {
	Handle(sockjs.Session) error
	Options() *sockjs.Options
	Validate(echo.Context) error
	Prefix() string
}

type Options

type Options struct {
	Handle   func(sockjs.Session) error
	Options  *sockjs.Options
	Validate func(echo.Context) error
	Prefix   string
}

func New

func New(prefix string, handler func(sockjs.Session) error) *Options

func (*Options) SetHandler

func (o *Options) SetHandler(handler func(sockjs.Session) error) *Options

func (*Options) SetOptions

func (o *Options) SetOptions(options *sockjs.Options) *Options

func (*Options) SetPrefix

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

func (*Options) SetValidator

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

func (Options) Wrapper

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