pool

Documentation

Index

• func ConvertTo(m *Message) (*message.Message, error)
• type Message
  • func (r *Message) Context() context.Context
  • func (r *Message) IsModified() bool
  • func (r *Message) IsSeparate() bool
  • func (r *Message) Marshal() ([]byte, error)
  • func (r *Message) MessageID() uint16
  • func (r *Message) Reset()
  • func (r *Message) SetMessageID(mid uint16)
  • func (r *Message) SetModified(b bool)
  • func (r *Message) SetType(typ udp.Type)
  • func (r *Message) String() string
  • func (r *Message) Type() udp.Type
  • func (r *Message) Unmarshal(data []byte) (int, error)
  • func (r *Message) UpsertMessageID(mid uint16) uint16
• type Pool
  • func New(maxNumMessages uint32, maxMessageBufferSize uint16) *Pool
  • func (p *Pool) AcquireMessage(ctx context.Context) *Message
  • func (p *Pool) ConvertFrom(m *message.Message) (*Message, error)
  • func (p *Pool) ReleaseMessage(req *Message)

Functions

func ConvertTo

func ConvertTo(m *Message) (*message.Message, error)

ConvertTo converts pool message to common message.

Types

type Message

type Message struct {
	*pool.Message
	// contains filtered or unexported fields
}

func (*Message) Context

func (r *Message) Context() context.Context

func (*Message) IsModified

func (r *Message) IsModified() bool

func (*Message) IsSeparate

func (r *Message) IsSeparate() bool

func (*Message) Marshal

func (r *Message) Marshal() ([]byte, error)

func (*Message) MessageID

func (r *Message) MessageID() uint16

func (*Message) Reset

func (r *Message) Reset()

Reset clear message for next reuse

func (*Message) SetMessageID

func (r *Message) SetMessageID(mid uint16)

func (*Message) SetModified

func (r *Message) SetModified(b bool)

func (*Message) SetType

func (r *Message) SetType(typ udp.Type)

func (*Message) String

func (r *Message) String() string

func (*Message) Type

func (r *Message) Type() udp.Type

func (*Message) Unmarshal

func (r *Message) Unmarshal(data []byte) (int, error)

func (*Message) UpsertMessageID

func (r *Message) UpsertMessageID(mid uint16) uint16

type Pool

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

func New

func New(maxNumMessages uint32, maxMessageBufferSize uint16) *Pool

func (*Pool) AcquireMessage

func (p *Pool) AcquireMessage(ctx context.Context) *Message

AcquireMessage returns an empty Message instance from Message pool.

The returned Message instance may be passed to ReleaseMessage when it is no longer needed. This allows Message recycling, reduces GC pressure and usually improves performance.

func (*Pool) ConvertFrom

func (p *Pool) ConvertFrom(m *message.Message) (*Message, error)

ConvertFrom converts common message to pool message.

func (*Pool) ReleaseMessage

func (p *Pool) ReleaseMessage(req *Message)

ReleaseMessage returns req acquired via AcquireMessage to Message pool.

It is forbidden accessing req and/or its' members after returning it to Message pool.