socket

Documentation

Index

• Constants
• type Context
  • func (s *Context) Close() error
  • func (s *Context) Read() ([]byte, error)
  • func (s *Context) Write(msg []byte) error
• type ContextSocket
  • func GetContextSocket(ctx context.Context, s *Socket) (ContextSocket, error)
• type NanomsgSocket
  • func (s *NanomsgSocket) Close() error
  • func (s *NanomsgSocket) Connect() error
  • func (s *NanomsgSocket) Get() (ReadWriter, error)
• type ReadWriter
• type Reader
  • func GetSubscriberSocket(ctx context.Context, s *Socket) (Reader, error)
• type Socket
• type SocketType
• type Writer

Constants

const (
	Requester        = SocketType("Requester")
	Replier          = SocketType("Replier")
	Publisher        = SocketType("Publisher")
	Subscriber       = SocketType("Subscriber")
	ContextRequester = SocketType("ContextRequester")
)

Types

type Context

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

func (*Context) Close

func (s *Context) Close() error

Close Closes the underlying socket

func (*Context) Read

func (s *Context) Read() ([]byte, error)

Read recieves bytes from socket. Goes from Recv to Read to match io.ReadWriteCloser interface

func (*Context) Write

func (s *Context) Write(msg []byte) error

Write Sends bytes over socket Goes from Send to Write to match io.ReadWriteCloser interface

type ContextSocket

type ContextSocket interface {
	Get() (ReadWriter, error)
	Close() error
}

func GetContextSocket

func GetContextSocket(ctx context.Context, s *Socket) (ContextSocket, error)

type NanomsgSocket

type NanomsgSocket struct {
	SocketType  SocketType `json:"socket_type"`
	Host        string     `json:"host"`
	Port        int        `json:"port"`
	Dial        bool       `json:"dial"`
	Listen      bool       `json:"listen"`
	RecvTimeout int        `json:"recv_timeout"`
	SendTimeout int        `json:"send_timeout"`
	// contains filtered or unexported fields
}

NanomsgSocket containes a raw mangosSocket that is constructed during connection. Also contains various configuration patterns used for construction

func (*NanomsgSocket) Close

func (s *NanomsgSocket) Close() error

func (*NanomsgSocket) Connect

func (s *NanomsgSocket) Connect() error

Connect creates a socket based on the SocketType. setting timeouts if specified.

func (*NanomsgSocket) Get

func (s *NanomsgSocket) Get() (ReadWriter, error)

OpenContext context socket can be used when duing parallel requests over a socket and wish to get responses back to match the request

type ReadWriter

type ReadWriter interface {
	Reader
	Writer
}

type Reader

type Reader interface {
	Read() ([]byte, error)
	Close() error
}

func GetSubscriberSocket

func GetSubscriberSocket(ctx context.Context, s *Socket) (Reader, error)

type Socket

type Socket struct {
	Type   SocketType `json:"type"`
	Host   string     `json:"host"`
	Port   int        `json:"port"`
	Listen bool       `json:"listen"`
	Dial   bool       `json:"dial"`
}

type SocketType

type SocketType string

type Writer

type Writer interface {
	Write([]byte) error
	Close() error
}