gosip

README

gosip

SIP stack in Go (RFC 3261)

PROJECT IS UNDER DEVELOPMENT

Inspired by:

• gossip
• go-sip
• sip.js

Documentation

Index

• Variables
• func Listen(network string, listenAddr string) error
• type RequestHandler
• type Server
  • func DefaultServer() *Server
  • func NewServer(config *ServerConfig) *Server
  • func (srv *Server) Listen(network string, listenAddr string) error
  • func (srv *Server) OnRequest(method sip.RequestMethod, handler RequestHandler) error
  • func (srv *Server) Request(req sip.Request) (<-chan sip.Response, error)
  • func (srv *Server) Respond(res sip.Response) (<-chan sip.Request, error)
  • func (srv *Server) Shutdown()
• type ServerConfig

Variables

var Version = "0.0.0"

Version is the current gosip package version

Functions

func Listen

func Listen(network string, listenAddr string) error

Listen starts SIP stack

Types

type RequestHandler

type RequestHandler func(req sip.Request)

RequestHandler is a callback that will be called on the incoming request of the certain method

type Server

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

Server is a SIP server

func DefaultServer

func DefaultServer() *Server

DefaultServer returns auto created default SIP server

func NewServer

func NewServer(config *ServerConfig) *Server

NewServer creates new instance of SIP server.

func (*Server) Listen

func (srv *Server) Listen(network string, listenAddr string) error

ListenAndServe starts serving listeners on the provided address

func (*Server) OnRequest

func (srv *Server) OnRequest(method sip.RequestMethod, handler RequestHandler) error

OnRequest registers new request callback

func (*Server) Request

func (srv *Server) Request(req sip.Request) (<-chan sip.Response, error)

Send SIP message

func (*Server) Respond

func (srv *Server) Respond(res sip.Response) (<-chan sip.Request, error)

func (*Server) Shutdown

func (srv *Server) Shutdown()

Shutdown gracefully shutdowns SIP server

type ServerConfig

type ServerConfig struct {
	HostAddr   string
	Extensions []string
}

ServerConfig describes available options