Getting Started

siplib is just a java library and is available through Maven Central and we will be using Maven in these examples. If you are new to Maven, then check out Maven: The Complete Reference, which should have you up and running in no time. If you are using any other build tools, their setup is usually quite similar so should not be hard to adopt the example below to fit your needs.

Setting up Maven

First, add a property to your POM with the current version of pkts.io, which is 3.0.2 (remember, siplib is part of pkts.io):

<properties>
    <pktsio.version>3.0.2</pktsio.version>
</properties>

Add the pkts-sip library as a dependency:

<dependencies>
    <dependency>
        <groupId>io.pkts</groupId>
        <artifactId>pkts-sip</artifactId>
        <version>${pktsio.version}</version>
    </dependency>
</dependencies>

Configure for Java 8

pkts.io, and therefore siplib, requires Java 8 so you need to configure your Maven setup to use Java 8. To do this, you need to configure your compiler, which in Maven is accomplished by re-configuring the maven-compiler-plugin like so:

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.1</version>
                <!-- compile for Java 1.8 -->
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>

Your final pom.xml should look like something like the following gist

Examples

Now that we have Maven setup we are ready to start coding. You can either continue reading in the docs section, which will explain the philosphy behind siplib, how lambda functions are used and show some of the common use cases, or you can just checkout the examples repository or even the junit tests if you really want to see the raw usage of siplib.

Javadoc

Javadocs for all releases are hosted by our friends at javadoc.io and the current release of pkts.io (and as such siplib) is accessed through the following links:

• siplib

Javadoc

Contributions are more than welcome and highly encouraged. Everything in siplib are following the general guidelines of Maven so if you are familiar with Maven you should have no problem getting started. Since siplib is part of pkts.io, please head over to that project site for a fuller description of how you can contribute.

License

pkts.io and all projects under aboutsip.com are released under the terms of the MIT license