session

Documentation

Index

• type Options
• type Session
  • func New(typ Type, identifier string, tr transport.Transport, hosts *host.Hosts, ...) *Session
  • func (ss *Session) Close(ctx context.Context) error
  • func (ss *Session) OpenComponent(ctx context.Context) error
  • func (ss *Session) OpenStream(ctx context.Context, featuresElem stravaganza.Element) error
  • func (ss *Session) Receive() (stravaganza.Element, error)
  • func (ss *Session) Reset(tr transport.Transport) error
  • func (ss *Session) Send(ctx context.Context, elem stravaganza.Element) error
  • func (ss *Session) SetFromJID(jd *jid.JID)
  • func (ss *Session) StreamID() string
• type Type

Types

type Options

type Options struct {

	// MaxStanzaSize defines the maximum stanza size that can be read from the session transport.
	MaxStanzaSize int

	// IsOut defines whether or not this is an initiating entity session.
	IsOut bool
}

Options structure is used to establish XMPP session options.

type Session

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

Session represents an XMPP session between two peers.

func New

func New(typ Type, identifier string, tr transport.Transport, hosts *host.Hosts, opts Options) *Session

New creates a new session instance.

func (*Session) Close

func (ss *Session) Close(ctx context.Context) error

Close closes session sending the proper XMPP payload.

func (*Session) OpenComponent

func (ss *Session) OpenComponent(ctx context.Context) error

OpenComponent initializes a component session sending the proper XMPP payload.

func (*Session) OpenStream

func (ss *Session) OpenStream(ctx context.Context, featuresElem stravaganza.Element) error

OpenStream initializes a session session sending the proper XMPP payload.

func (*Session) Receive

func (ss *Session) Receive() (stravaganza.Element, error)

Receive returns next incoming session element.

func (*Session) Reset

func (ss *Session) Reset(tr transport.Transport) error

Reset resets session internal state.

func (*Session) Send

func (ss *Session) Send(ctx context.Context, elem stravaganza.Element) error

Send writes an XML element to the underlying session transport.

func (*Session) SetFromJID

func (ss *Session) SetFromJID(jd *jid.JID)

SetFromJID updates current session from JID.

func (*Session) StreamID

func (ss *Session) StreamID() string

StreamID returns session stream identifier.

type Type

type Type uint8

Type represents session type.

const (
	// C2SSession represents a C2S session type.
	C2SSession Type = iota

	// S2SSession represents a S2S session type
	S2SSession

	// ComponentSession represents a component session type.
	ComponentSession
)