Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

websocket

package

Go to main page

Versions in this module

v1

v1.67.4

Jul 10, 2024

retracted

v1.67.3

Jun 11, 2024

retracted

v1.67.2

Mar 20, 2024

retracted

v1.67.1

Jan 29, 2024

retracted

v1.67.0

Oct 12, 2023

retracted

v1.66.4

Sep 27, 2023

retracted

Changes in this version

+ const DefaultConnectionInitTimeOut

+ const GraphQLTransportWSHeartbeatPayload

+ const HeaderSecWebSocketProtocol

+ var DefaultProtocol = ProtocolGraphQLTransportWS

+ var ErrGraphQLWSUnexpectedMessageType = errors.New("unexpected message type")

+ func Handle(done chan bool, errChan chan error, conn net.Conn, ...)

+ func HandleWithOptions(done chan bool, errChan chan error, conn net.Conn, ...)

+ type Client struct

+ func NewClient(logger abstractlogger.Logger, clientConn net.Conn) *Client

+ func (c *Client) Disconnect() error

+ func (c *Client) DisconnectWithReason(reason interface{}) error

+ func (c *Client) IsConnected() bool

+ func (c *Client) ReadBytesFromClient() ([]byte, error)

+ func (c *Client) WriteBytesToClient(message []byte) error

+ type CloseReason ws.Frame

+ func NewCloseReason(code uint16, reason string) CloseReason

+ type CompiledCloseReason []byte

+ var CompiledCloseReasonInternalServerError CompiledCloseReason = ws.MustCompileFrame(...)

+ var CompiledCloseReasonNormal CompiledCloseReason = ws.MustCompileFrame(...)

+ type GraphQLTransportWSEventHandler struct

+ OnConnectionOpened func()

+ Writer GraphQLTransportWSMessageWriter

+ func (g *GraphQLTransportWSEventHandler) Emit(eventType subscription.EventType, id string, data []byte, err error)

+ func (g *GraphQLTransportWSEventHandler) HandleWriteEvent(messageType GraphQLTransportWSMessageType, id string, data []byte, ...)

+ type GraphQLTransportWSMessage struct

+ Id string

+ Payload json.RawMessage

+ Type GraphQLTransportWSMessageType

+ type GraphQLTransportWSMessageReader struct

+ func (g *GraphQLTransportWSMessageReader) DeserializeSubscribePayload(message *GraphQLTransportWSMessage) (*GraphQLTransportWSMessageSubscribePayload, error)

+ func (g *GraphQLTransportWSMessageReader) Read(data []byte) (*GraphQLTransportWSMessage, error)

+ type GraphQLTransportWSMessageSubscribePayload struct

+ Extensions json.RawMessage

+ OperationName string

+ Query string

+ Variables json.RawMessage

+ type GraphQLTransportWSMessageType string

+ const GraphQLTransportWSMessageTypeComplete

+ const GraphQLTransportWSMessageTypeConnectionAck

+ const GraphQLTransportWSMessageTypeConnectionInit

+ const GraphQLTransportWSMessageTypeError

+ const GraphQLTransportWSMessageTypeNext

+ const GraphQLTransportWSMessageTypePing

+ const GraphQLTransportWSMessageTypePong

+ const GraphQLTransportWSMessageTypeSubscribe

+ type GraphQLTransportWSMessageWriter struct

+ Client subscription.TransportClient

+ func (g *GraphQLTransportWSMessageWriter) WriteComplete(id string) error

+ func (g *GraphQLTransportWSMessageWriter) WriteConnectionAck() error

+ func (g *GraphQLTransportWSMessageWriter) WriteError(id string, graphqlErrors graphql.RequestErrors) error

+ func (g *GraphQLTransportWSMessageWriter) WriteNext(id string, executionResult []byte) error

+ func (g *GraphQLTransportWSMessageWriter) WritePing(payload []byte) error

+ func (g *GraphQLTransportWSMessageWriter) WritePong(payload []byte) error

+ type GraphQLWSMessage struct

+ Id string

+ Payload json.RawMessage

+ Type GraphQLWSMessageType

+ type GraphQLWSMessageReader struct

+ func (g *GraphQLWSMessageReader) Read(data []byte) (*GraphQLWSMessage, error)

+ type GraphQLWSMessageType string

+ const GraphQLWSMessageTypeComplete

+ const GraphQLWSMessageTypeConnectionAck

+ const GraphQLWSMessageTypeConnectionError

+ const GraphQLWSMessageTypeConnectionInit

+ const GraphQLWSMessageTypeConnectionKeepAlive

+ const GraphQLWSMessageTypeConnectionTerminate

+ const GraphQLWSMessageTypeData

+ const GraphQLWSMessageTypeError

+ const GraphQLWSMessageTypeStart

+ const GraphQLWSMessageTypeStop

+ type GraphQLWSMessageWriter struct

+ Client subscription.TransportClient

+ func (g *GraphQLWSMessageWriter) WriteAck() error

+ func (g *GraphQLWSMessageWriter) WriteComplete(id string) error

+ func (g *GraphQLWSMessageWriter) WriteConnectionError(reason string) error

+ func (g *GraphQLWSMessageWriter) WriteData(id string, responseData []byte) error

+ func (g *GraphQLWSMessageWriter) WriteError(id string, errors graphql.RequestErrors) error

+ func (g *GraphQLWSMessageWriter) WriteKeepAlive() error

+ func (g *GraphQLWSMessageWriter) WriteTerminate(reason string) error

+ type GraphQLWSWriteEventHandler struct

+ Writer GraphQLWSMessageWriter

+ func (g *GraphQLWSWriteEventHandler) Emit(eventType subscription.EventType, id string, data []byte, err error)

+ func (g *GraphQLWSWriteEventHandler) HandleWriteEvent(messageType GraphQLWSMessageType, id string, data []byte, providedErr error)

+ type HandleOptionFunc func(opts *HandleOptions)

+ func WithCustomClient(client subscription.TransportClient) HandleOptionFunc

+ func WithCustomConnectionInitTimeOut(connectionInitTimeOut time.Duration) HandleOptionFunc

+ func WithCustomKeepAliveInterval(keepAliveInterval time.Duration) HandleOptionFunc

+ func WithCustomReadErrorTimeOut(readErrorTimeOut time.Duration) HandleOptionFunc

+ func WithCustomSubscriptionEngine(subscriptionEngine subscription.Engine) HandleOptionFunc

+ func WithCustomSubscriptionUpdateInterval(subscriptionUpdateInterval time.Duration) HandleOptionFunc

+ func WithInitFunc(initFunc InitFunc) HandleOptionFunc

+ func WithLogger(logger abstractlogger.Logger) HandleOptionFunc

+ func WithProtocol(protocol Protocol) HandleOptionFunc

+ func WithProtocolFromRequestHeaders(req *http.Request) HandleOptionFunc

+ type HandleOptions struct

+ CustomClient subscription.TransportClient

+ CustomConnectionInitTimeOut time.Duration

+ CustomKeepAliveInterval time.Duration

+ CustomReadErrorTimeOut time.Duration

+ CustomSubscriptionEngine subscription.Engine

+ CustomSubscriptionUpdateInterval time.Duration

+ Logger abstractlogger.Logger

+ Protocol Protocol

+ WebSocketInitFunc InitFunc

+ type InitFunc func(ctx context.Context, initPayload InitPayload) (context.Context, error)

+ type InitPayload json.RawMessage

+ func (p InitPayload) Authorization() string

+ func (p InitPayload) GetString(key string) string

+ type Protocol string

+ const ProtocolGraphQLTransportWS

+ const ProtocolGraphQLWS

+ const ProtocolUndefined

+ type ProtocolGraphQLTransportWSHandler struct

+ func NewProtocolGraphQLTransportWSHandler(client subscription.TransportClient) (*ProtocolGraphQLTransportWSHandler, error)

+ func NewProtocolGraphQLTransportWSHandlerWithOptions(client subscription.TransportClient, ...) (*ProtocolGraphQLTransportWSHandler, error)

+ func (p *ProtocolGraphQLTransportWSHandler) EventHandler() subscription.EventHandler

+ func (p *ProtocolGraphQLTransportWSHandler) Handle(ctx context.Context, engine subscription.Engine, data []byte) error

+ type ProtocolGraphQLTransportWSHandlerOptions struct

+ CustomInitTimeOutDuration time.Duration

+ CustomKeepAliveInterval time.Duration

+ Logger abstractlogger.Logger

+ WebSocketInitFunc InitFunc

+ type ProtocolGraphQLWSHandler struct

+ func NewProtocolGraphQLWSHandler(client subscription.TransportClient) (*ProtocolGraphQLWSHandler, error)

+ func NewProtocolGraphQLWSHandlerWithOptions(client subscription.TransportClient, opts ProtocolGraphQLWSHandlerOptions) (*ProtocolGraphQLWSHandler, error)

+ func (p *ProtocolGraphQLWSHandler) EventHandler() subscription.EventHandler

+ func (p *ProtocolGraphQLWSHandler) Handle(ctx context.Context, engine subscription.Engine, data []byte) error

+ type ProtocolGraphQLWSHandlerOptions struct

+ CustomKeepAliveInterval time.Duration

+ Logger abstractlogger.Logger

+ WebSocketInitFunc InitFunc

Other modules containing this package

github.com/wundergraph/graphql-go-tools/v2