sip

Documentation

Index

• Constants
• Variables
• type AuthenticationChallenge
• type AuthenticationHandler
  • func NewDigestHandler(username, password string) AuthenticationHandler
• type Connection
• type Dialog
  • func NewDialog(transport Transport, caller URI, ...) *Dialog
  • func (d *Dialog) Ring(callee URI, maxRingingTime time.Duration) (bool, error)
• type Header
  • func (h Header) Add(key, value string)
  • func (h Header) Contains(key string) bool
  • func (h Header) DebugString() string
  • func (h Header) Get(key string) string
  • func (h Header) ParseHeader(line string) error
  • func (h Header) Set(key, value string)
  • func (h Header) Write(w io.Writer) error
• type Request
  • func NewRequest(method string, uri URI) *Request
  • func (r *Request) DebugString() string
  • func (r *Request) SetBody(contentType string, body []byte)
  • func (r *Request) Write(w io.Writer) error
• type Response
  • func ParseResponse(r io.Reader) (*Response, error)
  • func RecvFinal(c Connection) (*Response, error)
  • func (r *Response) DebugString() string
• type TCPTransport
  • func (t *TCPTransport) Send(req *Request) (Connection, error)
• type Transport
• type URI
  • func NewURI(scheme, address, host string, port int) URI
  • func ParseURI(uri string) (URI, error)
  • func (u URI) String() string

Constants

const (
	StatusOK               = 200
	StatusRequestCancelled = 487
	StatusDecline          = 603
)

Variables

var (
	ErrInvalidAuthenticationChallenge     = errors.New("invalid authentication challenge")
	ErrUnsolveableAuthenticationChallenge = errors.New("unsolveable authentication challenge")
)

var (
	ErrInvaldURI = errors.New("invalid uri")
)

var (
	ErrParsingError = errors.New("error parsing response")
)

var (
	ErrRoundTripFailed = errors.New("round trip failed")
)

Types

type AuthenticationChallenge

type AuthenticationChallenge struct {
	Method     string
	Properties map[string]string
}

type AuthenticationHandler

type AuthenticationHandler interface {
	Solve(challenge AuthenticationChallenge, req *Request) error
}

func NewDigestHandler

func NewDigestHandler(username, password string) AuthenticationHandler

type Connection

type Connection interface {
	Send(*Request) error
	Recv() (*Response, error)
	Close() error
}

type Dialog

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

func NewDialog

func NewDialog(transport Transport, caller URI, authenticationHandlers ...AuthenticationHandler) *Dialog

func (*Dialog) Ring

func (d *Dialog) Ring(callee URI, maxRingingTime time.Duration) (bool, error)

type Header

type Header map[string][]string

func (Header) Add

func (h Header) Add(key, value string)

func (Header) Contains

func (h Header) Contains(key string) bool

func (Header) DebugString

func (h Header) DebugString() string

func (Header) Get

func (h Header) Get(key string) string

func (Header) ParseHeader

func (h Header) ParseHeader(line string) error

func (Header) Set

func (h Header) Set(key, value string)

func (Header) Write

func (h Header) Write(w io.Writer) error

type Request

type Request struct {
	Method string
	URI    URI
	Header Header
	Body   []byte
}

func NewRequest

func NewRequest(method string, uri URI) *Request

func (*Request) DebugString

func (r *Request) DebugString() string

func (*Request) SetBody

func (r *Request) SetBody(contentType string, body []byte)

func (*Request) Write

func (r *Request) Write(w io.Writer) error

type Response

type Response struct {
	StatusCode            int
	StatusMessage         string
	Protocol              string
	Header                Header
	Body                  []byte
	LocalAddr, RemoteAddr net.Addr
}

func ParseResponse

func ParseResponse(r io.Reader) (*Response, error)

func RecvFinal

func RecvFinal(c Connection) (*Response, error)

func (*Response) DebugString

func (r *Response) DebugString() string

type TCPTransport

type TCPTransport struct {
	DumpRoundTrips bool
}

func (*TCPTransport) Send

func (t *TCPTransport) Send(req *Request) (Connection, error)

type Transport

type Transport interface {
	Send(*Request) (Connection, error)
}

type URI

type URI struct {
	Scheme  string
	Address string
	Host    string
	Port    int
}

func NewURI

func NewURI(scheme, address, host string, port int) URI

func ParseURI

func ParseURI(uri string) (URI, error)

func (URI) String

func (u URI) String() string