This documentation relates to an unstable version of Cipango.
visit the current release documentation home.

Web Sockets Connector

Cipango offers an support of the The WebSocket Protocol as a Transport for the Session Initiation Protocol|http://tools.ietf.org/html/draft-ietf-sipcore-sip-websocket-07] draft.

To use WebSockets transport,

  1. Cipango should be start with configuration etc/cipango-websocket.xml. This can be done by adding the following two lines in start.d/100-sip.ini
    OPTIONS=websocket
    etc/cipango-websocket.xml
    
  2. your SIP Application should add in WEB-INF/web.xml the servlet org.cipango.websocket.SipWebsocketServlet.
    web.xml
    <?xml version="1.0" encoding="ISO-8859-1"?>
    <web-app
       xmlns="http://java.sun.com/xml/ns/javaee"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
       version="2.5">
       
      <servlet>
        <servlet-name>SipWebsocketServlet</servlet-name>
        <servlet-class>org.cipango.websocket.SipWebsocketServlet</servlet-class>
      </servlet>
      
      <servlet-mapping>
        <servlet-name>SipWebsocketServlet</servlet-name>
        <url-pattern>/*</url-pattern>
      </servlet-mapping>
    
    </web-app>
    

The host name (jetty.host property in the start command line above) of the HTTP connector must be set since it is necessary to the SIP WebSockets connector.