websocket

type CloseError struct {
	Code   int
	Reason string
}

type Dialer struct {
	/*
		Header to be included in the opening handshake request.
	*/
	Header http.Header

	/*
		SubProtocols which the client supports.
	*/
	SubProtocols []string

	/*
		TLSConfig is used to configure the TLS client.
	*/
	TLSConfig *tls.Config
}

type OpenError struct {
	Reason string
}

type Request struct {

	/*
		CheckOrigin is the function which will be used to validate the ORIGIN
		HTTP Header of the request. By default this method will fail the opening
		handshake when the origin is not the same. This method can be overridden
		during the initiation of the Request struct.
	*/
	CheckOrigin func(r *http.Request) bool

	/*
		SubProtocol name which the server has agreed to use from the list
		provided by the client (through the Sec-WebSocket-Protocol HTTP Header
		Field). Before sending the servers opening handshake response, checks
		are made to verify that the chosen protocol was indeed been provided as
		an option from the client. If this is not the case, the HTTP
		Sec-WebSocket-Protocol HTTP Response Header Field is not sent
	*/
	SubProtocol string
	// contains filtered or unexported fields
}

type Socket struct {

	/*
		closeDelay is the duration the socket instance will wait until it closes
		the underlying tcp connection once the closing handshake has been
		completed.

		The websocket rfc suggests that when the closing handshake is completed
		the underlying tcp connection should first be terminated by the server
		endpoint. Having said this it doesn't restrict the client endpoint to do
		so itself. CloseDelay is the maximum time the socket instance will wait
		before it closes the tcp connection.

		Note: Server endpoints should always have this property set to 0.

		Ref Spec: https://tools.ietf.org/html/rfc6455#section-5.5.1
	*/
	CloseDelay time.Duration

	/*
		readHandler is invoked whenever a text or binary frame is received. The
		opcode and payload data are provided as args respectively.
	*/
	ReadHandler func(int, []byte)

	/*
		pingHandler is invoked whenever a ping frame is received. The payload
		data is provided as arg.
	*/
	PingHandler func([]byte)

	/*
		pongHandler is invoked whenever a pong frame is received. The payload
		data is provided as arg.
	*/
	PongHandler func([]byte)

	/*
		closeHandler is invoked whenever the websocket connection is closed. The
		reason for the closure is provided as an arg.
	*/
	CloseHandler func(error)
	// contains filtered or unexported fields
}