Git Product home page Git Product logo

icelib's Introduction

Build Status Coverage Status Coverity Scan Build Status GitHub version

icelib

An ICE implementation.

Compiling

build.sh does the following

mkdir build     (hold all of the build files in a separate directory)
cd build; cmake (create the makefiles)
make            (To build the code)

You will end up with a library you can link against in build/dist/lib.

Development

You need to have cmake to build. Note that version 3.2 or newer is needed. (Some linux distributions are a bit slow to update, so manuall install may be needed.)

Unit Tests

Build and run the checks with

make -C build test

If tests fail it can help to run the binaries in build/dist/test to see where they fail.

Travis will compile and run the tests.

Coverage

Coveralls use the coverage.sh script to generate coverage reports.

To manually generate lcov reports you can run the ./coveragereport.sh script. A nice html page can be found in lcov/index.html

It can be a bit tricky to get your favorite platform to support gcov and friends, but do not give up! (I had problems on os-x, but unfortunately I do not remember how it was fixed)

Coding Standard

Using uncrustify to clean up code. There is a uncrustify.cfg file that describes the format. Run uncrustify before posting pull requests.

Semantic versioning is used.

Contributing

Fork and send pull requests. Please add your name to the AUTHORS list in your first patch.

License

BSD 2-clause:

Copyright (c) 2015, ICElib AUTHORS All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

icelib's People

Contributors

linuxwolf avatar mikehorb avatar palerikm avatar sstorm avatar trondand avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

icelib's Issues

IPv6 Candidate pairing

Need to update how those a paired.

Make sure:

  • Only link local to link local (No link local to other..)
  • no loopback addresses (Should library check or up to client?)
  • No Relay to any private address (IPv4 and IPv6)

The discovered PRFLX priority doesn't follow spec

The discovered PRFLX priority, RFC 5245 says "Its priority is set equal to the value of the PRIORITY attribute in the Binding request.", but our code is written in function void ICELIB_makePeerLocalReflexiveCandidate:

    pPeerCandidate->priority = ICELIB_calculatePriority(ICE_CAND_TYPE_PRFLX,
                                                        componentId, 0xffff);

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.