package wsstream

import "k8s.io/apimachinery/pkg/util/httpstream/wsstream"

Package wsstream contains compatibility wrappers for websocket streaming.

Deprecated: use k8s.io/streaming/pkg/httpstream/wsstream directly.

Index ¶

• Constants
• func IgnoreReceives(ws *websocket.Conn, timeout time.Duration)
• func IgnoreReceivesWithLogger(logger klog.Logger, ws *websocket.Conn, timeout time.Duration)
• func IsWebSocketRequest(req *http.Request) bool
• func IsWebSocketRequestWithStreamCloseProtocol(req *http.Request) bool
• func IsWebSocketRequestWithTunnelingProtocol(req *http.Request) bool
• func NewDefaultChannelProtocols(channels []ChannelType) map[string]ChannelProtocolConfig
• func NewDefaultReaderProtocols() map[string]ReaderProtocolConfig
• type ChannelProtocolConfig
• type ChannelType
• type Conn
• func NewConn(protocols map[string]ChannelProtocolConfig) *Conn
• type Reader
• func NewReader(r io.Reader, ping bool, protocols map[string]ReaderProtocolConfig) *Reader
• func NewReaderWithLogger(logger klog.Logger, r io.Reader, ping bool, protocols map[string]ReaderProtocolConfig) *Reader
• type ReaderProtocolConfig

Constants ¶

const (
	WebSocketProtocolHeader        = streamws.WebSocketProtocolHeader
	ChannelWebSocketProtocol       = streamws.ChannelWebSocketProtocol
	Base64ChannelWebSocketProtocol = streamws.Base64ChannelWebSocketProtocol
)

const (
	IgnoreChannel    = streamws.IgnoreChannel
	ReadChannel      = streamws.ReadChannel
	WriteChannel     = streamws.WriteChannel
	ReadWriteChannel = streamws.ReadWriteChannel
)

Functions ¶

func IgnoreReceives ¶

func IgnoreReceives(ws *websocket.Conn, timeout time.Duration)

func IgnoreReceivesWithLogger ¶

func IgnoreReceivesWithLogger(logger klog.Logger, ws *websocket.Conn, timeout time.Duration)

func IsWebSocketRequest ¶

func IsWebSocketRequest(req *http.Request) bool

func IsWebSocketRequestWithStreamCloseProtocol ¶

func IsWebSocketRequestWithStreamCloseProtocol(req *http.Request) bool

func IsWebSocketRequestWithTunnelingProtocol ¶

func IsWebSocketRequestWithTunnelingProtocol(req *http.Request) bool

func NewDefaultChannelProtocols ¶

func NewDefaultChannelProtocols(channels []ChannelType) map[string]ChannelProtocolConfig

func NewDefaultReaderProtocols ¶

func NewDefaultReaderProtocols() map[string]ReaderProtocolConfig

Types ¶

type ChannelProtocolConfig ¶

type ChannelProtocolConfig = streamws.ChannelProtocolConfig

type ChannelType ¶

type ChannelType = streamws.ChannelType

type Conn ¶

type Conn = streamws.Conn

func NewConn ¶

func NewConn(protocols map[string]ChannelProtocolConfig) *Conn

type Reader ¶

type Reader = streamws.Reader

func NewReader ¶

func NewReader(r io.Reader, ping bool, protocols map[string]ReaderProtocolConfig) *Reader

func NewReaderWithLogger ¶

func NewReaderWithLogger(logger klog.Logger, r io.Reader, ping bool, protocols map[string]ReaderProtocolConfig) *Reader

type ReaderProtocolConfig ¶

type ReaderProtocolConfig = streamws.ReaderProtocolConfig

Source Files ¶

doc.go wsstream.go