gorilla

Documentation

Overview

Package gorillaは、Gorilla WebSocket(https://github.com/gorilla/websocket) を使ってWebSocket接続を行うためのパッケージです。

Index

• func Dial(wsURL string, token *websocket.Token) (websocket.Conn, error)
• func DialWithTLS(c websocket.DialConfig) (websocket.Conn, error)
• type Conn
  • func New(wsconn *gwebsocket.Conn) *Conn
  • func (c *Conn) Close() error
  • func (c *Conn) Ping(ctx context.Context) error
  • func (c *Conn) Reader(ctx context.Context) (websocket.MessageType, io.Reader, error)
  • func (c *Conn) Writer(ctx context.Context, tp websocket.MessageType) (io.WriteCloser, error)
• type Dialer

Functions

func Dial

func Dial(wsURL string, token *websocket.Token) (websocket.Conn, error)

Dialは、WebSocketのコネクションを開きます。

`token` はWebSocket接続時の認証ヘッダーに使用します。

func DialWithTLS

func DialWithTLS(c websocket.DialConfig) (websocket.Conn, error)

DialWithTLSは、WebSocketのコネクションを開きます。

`token` はWebSocket接続時の認証ヘッダーに使用します。 `tlsConfig` がnilの場合は無視します。

Types

type Conn

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

Connは、 gorilla/websocketのConnのラッパーです。

func New

func New(wsconn *gwebsocket.Conn) *Conn

Newは、Connを返却します。

func (*Conn) Close

func (c *Conn) Close() error

Closeは、WebSocketをクローズします。

func (*Conn) Ping

func (c *Conn) Ping(ctx context.Context) error

Pingは、WebSocketのPingを送信します。

func (*Conn) Reader

func (c *Conn) Reader(ctx context.Context) (websocket.MessageType, io.Reader, error)

Readerは、WebSocketのReaderを取得します。

func (*Conn) Writer

func (c *Conn) Writer(ctx context.Context, tp websocket.MessageType) (io.WriteCloser, error)

Writerは、WebSocketのWriterを取得します。

type Dialer

type Dialer struct{}

Dialerは、WebSocketのコネクションを開きます。