https://github.com/gmazovec/sipcore

General purpose SIP library for NodeJS and Web browsers.
https://github.com/gmazovec/sipcore

javascript sip

Last synced: about 1 year ago
JSON representation

General purpose SIP library for NodeJS and Web browsers.

• Host: GitHub
• URL: https://github.com/gmazovec/sipcore
• Owner: gmazovec
• License: other
• Created: 2013-02-22T16:48:51.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2014-11-27T14:09:36.000Z (over 11 years ago)
• Last Synced: 2024-03-23T03:22:54.063Z (over 2 years ago)
• Topics: javascript, sip
• Language: JavaScript
• Homepage:
• Size: 621 KB
• Stars: 19
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

          
sipcore.js

==========

General purpose SIP library for JavaScript.

## Installation

    npm install sipcore

## API

    SIP.format (msg, compact)

    SIP.parse (text)

    SIP.parseUri (text)

    SIP.formatUri (uri)

    SIP.isMessage (obj)

    SIP.createMessage (obj)

    Message.getHeader (name, parse, pos)

    Message.setHeader (name, value, pos)

    Message.toResponse (status, reason)

    Message.toRequest (method, uri)

    Message.copy ()

    Message.format (compact)

    SIP.createProtocol([constructor], [options])

    SIP.createTransport ()

    Transport.register (protocol, [port], [address])

    Transport.listen ([cb])

    Transport.isListening ([protocol])

    Transport.send (msg, [address], [port], [protocol], [cb])

    Transport.close ()

    Event: Transport.on('message', function (msg))

    Event: Transport.on('listening', function (listenState))

    SIP.createTransaction (transport, [msg])

    Transaction.state

    Transaction.timeout

    Transaction.error

    Transaction.send (msg, [addr], [port], [protocol], [cb])

    Transaction.send (msg, [cb])

    Transaction.on('message', function (message))

    Transaction.on('state', function (state)

    Transaction.on('timeout', function ())

## Example

```javascript

var sip = require('sipcore');

var protocol = sip.createProtocol();

var transport = sip.createTransport();

transport.register(protocol);

transport.listen(function (listenState) {

    console.log('* HEAP listening...', listenState.heap ? 'ok' : 'failed');

});

transport.on('message', function (msg) {

    console.log('-- new SIP message');

    console.log(msg.format());

});

```