udp

README

UDP

Provides two sub-packages

• udps (UDP Server)
• udpc (UDP Client)

Example

TODO

Documentation

Overview

Package udp provides common functionality used in udpc and udps packages

Index

• type Client
• type Stream
  • func HandleStream(logger *logrus.Logger, stream quic.Stream, ...) (cstream *Stream, err error)
  • func NewStream(data map[string]string, channel *network.Channel) (s *Stream, err error)
  • func NewStreamFromData(data *model.StreamConnectionData, channel *network.Channel) *Stream
  • func (s *Stream) Channel() *network.Channel
  • func (s *Stream) Close()
  • func (s *Stream) Stream() quic.Stream
  • func (s *Stream) String() string
• type StreamHandler

Types

type Client

type Client interface {
	// ID
	ID() string
	// Stringify
	String() string
	// Closes the client
	Close(code int, reason string)

	// Sends a Message to the Server
	Send(msg *network.Message) (rmsg *network.Message, err error)
	// Opens a Stream to the Server
	OpenStream(data map[string]string) (stream *Stream, err error)
	// Closes a Stream
	CloseStream(id string)
}

Client Interface stipulates functions which should be present in a client

type Stream

type Stream struct {
	// Stream ID
	Id string

	// Stream Metadata
	Data map[string]string

	// Exit Channel
	Exit chan bool
	// Closed Status
	Closed bool
	// contains filtered or unexported fields
}

Stream holds the configuration related to a single Stream

func HandleStream

func HandleStream(logger *logrus.Logger, stream quic.Stream, unmarshalers []network.ChannelUnmarshaler) (cstream *Stream, err error)

HandleStream wraps the quic.Stream and provides useful functionality to manage it

func NewStream

func NewStream(data map[string]string, channel *network.Channel) (s *Stream, err error)

Wraps a channel into a Stream and initializes it

func NewStreamFromData

func NewStreamFromData(data *model.StreamConnectionData, channel *network.Channel) *Stream

Wraps a channel into a Stream and does not initialize it This function should be used when the stream is already initialized

func (*Stream) Channel

func (s *Stream) Channel() *network.Channel

Returns the channel associated with the Stream

func (*Stream) Close

func (s *Stream) Close()

Closes the Stream

func (*Stream) Stream

func (s *Stream) Stream() quic.Stream

Returns the Raw Stream

func (*Stream) String

func (s *Stream) String() string

Stringify

type StreamHandler

type StreamHandler func(Client, *Stream)

On New Stream Handler