client

Documentation

Index

• type CBORSpoolReadDescriptor
• type SpoolReadDescriptor
  • func NewSpoolReadDescriptor(receiver, provider string, session *client.Session) (*SpoolReadDescriptor, error)
  • func (r *SpoolReadDescriptor) GetWriteDescriptor() *SpoolWriteDescriptor
  • func (r *SpoolReadDescriptor) IncrementOffset()
  • func (s *SpoolReadDescriptor) ToCBOR() *CBORSpoolReadDescriptor
• type SpoolWriteDescriptor

Types

type CBORSpoolReadDescriptor

type CBORSpoolReadDescriptor struct {
	// PrivateKey is the key material required for reading the described spool.
	PrivateKey []byte

	// ID is the identity of the described spool.
	ID [common.SpoolIDSize]byte

	// Receiver is the responding service name of the SURB based spool service.
	Receiver string

	// Provider is the name of the Provider hosting the spool.
	Provider string

	// ReadOffset is the number of messages to offset the next read from this
	// described spool.
	ReadOffset uint32
}

type SpoolReadDescriptor

type SpoolReadDescriptor struct {
	// PrivateKey is the key material required for reading the described spool.
	PrivateKey sign.PrivateKey

	// ID is the identity of the described spool.
	ID [common.SpoolIDSize]byte

	// Receiver is the responding service name of the SURB based spool service.
	Receiver string

	// Provider is the name of the Provider hosting the spool.
	Provider string

	// ReadOffset is the number of messages to offset the next read from this
	// described spool.
	ReadOffset uint32
}

SpoolReadDescriptor describes a remotely readable spool.

func NewSpoolReadDescriptor

func NewSpoolReadDescriptor(receiver, provider string, session *client.Session) (*SpoolReadDescriptor, error)

NewSpoolReadDescriptor blocks until the remote spool is created or the round trip timeout is reached.

func (*SpoolReadDescriptor) GetWriteDescriptor

func (r *SpoolReadDescriptor) GetWriteDescriptor() *SpoolWriteDescriptor

GetWriteDescriptor returns a SpoolWriteDescriptor which can used write to the given spool.

func (*SpoolReadDescriptor) IncrementOffset

func (r *SpoolReadDescriptor) IncrementOffset()

IncrementOffset increments the ReadOffset

func (*SpoolReadDescriptor) ToCBOR

func (s *SpoolReadDescriptor) ToCBOR() *CBORSpoolReadDescriptor

type SpoolWriteDescriptor

type SpoolWriteDescriptor struct {
	// ID is the identity of the described spool.
	ID [common.SpoolIDSize]byte

	// Receiver is the responding service name of the SURB based spool service.
	Receiver string

	// Provider is the name of the Provider hosting the spool.
	Provider string
}

SpoolWriteDescriptor describes a remotely writable spool.