nanomsg.org/go/mangos/v2@v2.0.9-0.20200203084354-8a092611e461/protocol/rep/rep.go

// Copyright 2019 The Mangos Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use file except in compliance with the License.
// You may obtain a copy of the license at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package rep implements the REP protocol, which is the response side of
// the request/response pattern.  (REQ is the request.)
package rep

import (
	"sync"
	"time"

	"nanomsg.org/go/mangos/v2/protocol"
)

// Protocol identity information.
const (
	Self     = protocol.ProtoRep
	Peer     = protocol.ProtoReq
	SelfName = "rep"
	PeerName = "req"
)

type pipe struct {
	s      *socket
	p      protocol.Pipe
	sendQ  chan *protocol.Message
	closeQ chan struct{}
}

type recvQEntry struct {
	m *protocol.Message
	p *pipe
}

type socket struct {
	closed   bool
	ttl      int
	sendQLen int
	recvQ    chan recvQEntry
	contexts map[*context]struct{}
	master   *context
	sync.Mutex
}

type context struct {
	s          *socket
	closed     bool
	recvWait   bool
	recvExpire time.Duration
	recvPipe   *pipe
	closeQ     chan struct{}
	sendExpire time.Duration
	bestEffort bool
	backtrace  []byte
}

// closedQ represents a non-blocking time channel.
var closedQ <-chan time.Time

// nilQ represents a nil time channel (blocks forever)
var nilQ <-chan time.Time

func init() {
	tq := make(chan time.Time)
	closedQ = tq
	close(tq)
}

func (c *context) RecvMsg() (*protocol.Message, error) {
	s := c.s
	s.Lock()

	if c.closed {
		s.Unlock()
		return nil, protocol.ErrClosed
	}
	if c.recvWait {
		s.Unlock()
		return nil, protocol.ErrProtoState
	}
	c.recvWait = true

	cq := c.closeQ
	wq := nilQ
	expireTime := c.recvExpire
	s.Unlock()

	if expireTime > 0 {
		wq = time.After(expireTime)
	}

	var err error
	var m *protocol.Message
	var p *pipe

	select {
	case entry := <-s.recvQ:
		m, p = entry.m, entry.p
	case <-wq:
		err = protocol.ErrRecvTimeout
	case <-cq:
		err = protocol.ErrClosed
	}

	s.Lock()

	if m != nil {
		c.backtrace = append([]byte{}, m.Header...)
		m.Header = nil
		c.recvPipe = p
	}
	c.recvWait = false
	s.Unlock()
	return m, err
}

func (c *context) SendMsg(m *protocol.Message) error {
	r := c.s
	r.Lock()

	if r.closed || c.closed {
		r.Unlock()
		return protocol.ErrClosed
	}
	if c.backtrace == nil {
		r.Unlock()
		return protocol.ErrProtoState
	}
	p := c.recvPipe
	c.recvPipe = nil

	bestEffort := c.bestEffort
	timeQ := nilQ
	if bestEffort {
		timeQ = closedQ
	} else if c.sendExpire > 0 {
		timeQ = time.After(c.sendExpire)
	}

	m.Header = c.backtrace
	c.backtrace = nil
	cq := c.closeQ
	r.Unlock()

	select {
	case <-cq:
		m.Header = nil
		return protocol.ErrClosed
	case <-p.closeQ:
		// Pipe closed, so no way to get it to the recipient.
		// Just discard the message.
		m.Free()
		return nil
	case <-timeQ:
		if bestEffort {
			// No way to report to caller, so just discard
			// the message.
			m.Free()
			return nil
		}
		m.Header = nil
		return protocol.ErrSendTimeout

	case p.sendQ <- m:
		return nil
	}
}

func (c *context) Close() error {
	s := c.s
	s.Lock()
	if c.closed {
		s.Unlock()
		return protocol.ErrClosed
	}
	delete(s.contexts, c)
	c.closed = true
	close(c.closeQ)
	s.Unlock()
	return nil
}

func (c *context) GetOption(name string) (interface{}, error) {
	switch name {
	case protocol.OptionBestEffort:
		c.s.Lock()
		v := c.bestEffort
		c.s.Unlock()
		return v, nil

	case protocol.OptionRecvDeadline:
		c.s.Lock()
		v := c.recvExpire
		c.s.Unlock()
		return v, nil

	case protocol.OptionSendDeadline:
		c.s.Lock()
		v := c.sendExpire
		c.s.Unlock()
		return v, nil

	default:
		return nil, protocol.ErrBadOption
	}
}

func (c *context) SetOption(name string, v interface{}) error {
	switch name {
	case protocol.OptionBestEffort:
		if val, ok := v.(bool); ok {
			c.s.Lock()
			c.bestEffort = val
			c.s.Unlock()
			return nil
		}
		return protocol.ErrBadValue

	case protocol.OptionSendDeadline:
		if val, ok := v.(time.Duration); ok && val > 0 {
			c.s.Lock()
			c.sendExpire = val
			c.s.Unlock()
			return nil
		}
		return protocol.ErrBadValue

	case protocol.OptionRecvDeadline:
		if val, ok := v.(time.Duration); ok && val > 0 {
			c.s.Lock()
			c.recvExpire = val
			c.s.Unlock()
			return nil
		}
		return protocol.ErrBadValue

	default:
		return protocol.ErrBadOption
	}
}

func (p *pipe) receiver() {
	s := p.s
outer:
	for {
		m := p.p.RecvMsg()
		if m == nil {
			break
		}

		// Move backtrace from body to header.
		hops := 0
		for {
			if hops >= s.ttl {
				m.Free() // ErrTooManyHops
				continue outer
			}
			hops++
			if len(m.Body) < 4 {
				m.Free() // ErrGarbled
				continue outer
			}
			m.Header = append(m.Header, m.Body[:4]...)
			m.Body = m.Body[4:]
			// Check for high order bit set (0x80000000, big endian)
			if m.Header[len(m.Header)-4]&0x80 != 0 {
				break
			}
		}

		entry := recvQEntry{m: m, p: p}
		select {
		case s.recvQ <- entry:
		case <-p.closeQ:
			// Either the pipe or the socket has closed (which
			// closes the pipe.)  In either case, we have no
			// way to return a response, so we have to abandon.
			m.Free()
			break outer
		}
	}
	go p.close()
}

func (p *pipe) sender() {
	for {
		select {
		case m := <-p.sendQ:
			if p.p.SendMsg(m) != nil {
				p.close()
				return
			}
		case <-p.closeQ:
			return
		}
	}
}

func (p *pipe) close() {
	_ = p.p.Close()
}

func (s *socket) Close() error {

	s.Lock()

	if s.closed {
		s.Unlock()
		return protocol.ErrClosed
	}
	s.closed = true
	var contexts []*context
	for c := range s.contexts {
		contexts = append(contexts, c)
	}
	s.Unlock()

	for _, c := range contexts {
		_ = c.Close()
	}
	return nil
}

func (*socket) Info() protocol.Info {
	return protocol.Info{
		Self:     Self,
		Peer:     Peer,
		SelfName: SelfName,
		PeerName: PeerName,
	}
}

func (s *socket) AddPipe(pp protocol.Pipe) error {

	p := &pipe{
		p:      pp,
		s:      s,
		sendQ:  make(chan *protocol.Message, s.sendQLen),
		closeQ: make(chan struct{}),
	}
	pp.SetPrivate(p)
	s.Lock()
	if s.closed {
		s.Unlock()
		return protocol.ErrClosed
	}
	go p.sender()
	go p.receiver()
	s.Unlock()
	return nil
}

func (s *socket) RemovePipe(pp protocol.Pipe) {

	p := pp.GetPrivate().(*pipe)
	close(p.closeQ)
}

func (s *socket) SetOption(name string, v interface{}) error {
	switch name {
	case protocol.OptionWriteQLen:
		if qlen, ok := v.(int); ok && qlen >= 0 {
			s.Lock()
			s.sendQLen = qlen
			s.Unlock()
			return nil
		}
		return protocol.ErrBadValue

	case protocol.OptionTTL:
		if ttl, ok := v.(int); ok && ttl > 0 && ttl < 256 {
			s.Lock()
			s.ttl = ttl
			s.Unlock()
			return nil
		}
		return protocol.ErrBadValue
	}
	return s.master.SetOption(name, v)
}

func (s *socket) GetOption(name string) (interface{}, error) {
	switch name {
	case protocol.OptionRaw:
		return false, nil
	case protocol.OptionTTL:
		s.Lock()
		v := s.ttl
		s.Unlock()
		return v, nil
	case protocol.OptionWriteQLen:
		s.Lock()
		v := s.sendQLen
		s.Unlock()
		return v, nil
	}

	return s.master.GetOption(name)
}

func (s *socket) OpenContext() (protocol.Context, error) {
	s.Lock()
	defer s.Unlock()
	if s.closed {
		return nil, protocol.ErrClosed
	}
	c := &context{
		s:      s,
		closeQ: make(chan struct{}),
	}
	s.contexts[c] = struct{}{}
	return c, nil
}

func (s *socket) RecvMsg() (*protocol.Message, error) {
	return s.master.RecvMsg()
}

func (s *socket) SendMsg(m *protocol.Message) error {
	return s.master.SendMsg(m)
}

// NewProtocol allocates a protocol state for the REP protocol.
func NewProtocol() protocol.Protocol {
	s := &socket{
		ttl:      8,
		contexts: make(map[*context]struct{}),
		recvQ:    make(chan recvQEntry), // unbuffered!
		master: &context{
			closeQ: make(chan struct{}),
		},
	}
	s.master.s = s
	s.contexts[s.master] = struct{}{}
	return s
}

// NewSocket allocates a new Socket using the REP protocol.
func NewSocket() (protocol.Socket, error) {
	return protocol.MakeSocket(NewProtocol()), nil
}