session

Documentation

Overview

Package session provides functions for sessions of incoming requests.

Index

• func ContextWithID(ctx context.Context, id ID) context.Context
• func ContextWithInbound(ctx context.Context, inbound *Inbound) context.Context
• func ContextWithOutbound(ctx context.Context, outbound *Outbound) context.Context
• func ExportIDToError(ctx context.Context) errors.ExportOption
• type ID
  • func IDFromContext(ctx context.Context) ID
  • func NewID() ID
• type Inbound
  • func InboundFromContext(ctx context.Context) *Inbound
• type Outbound
  • func OutboundFromContext(ctx context.Context) *Outbound

Functions

func ContextWithID

func ContextWithID(ctx context.Context, id ID) context.Context

ContextWithID returns a new context with the given ID.

func ContextWithInbound

func ContextWithInbound(ctx context.Context, inbound *Inbound) context.Context

func ContextWithOutbound

func ContextWithOutbound(ctx context.Context, outbound *Outbound) context.Context

func ExportIDToError

func ExportIDToError(ctx context.Context) errors.ExportOption

Types

type ID

type ID uint32

ID of a session.

func IDFromContext

func IDFromContext(ctx context.Context) ID

IDFromContext returns ID in this context, or 0 if not contained.

func NewID

func NewID() ID

NewID generates a new ID. The generated ID is high likely to be unique, but not cryptographically secure. The generated ID will never be 0.

type Inbound

type Inbound struct {
	Source  net.Destination
	Gateway net.Destination
	Tag     string
}

func InboundFromContext

func InboundFromContext(ctx context.Context) *Inbound

type Outbound

type Outbound struct {
	Target      net.Destination
	Gateway     net.Address
	ResolvedIPs []net.IP
}

func OutboundFromContext

func OutboundFromContext(ctx context.Context) *Outbound