Merlin

####"An ok name for a library"

Merlin aims to simplify network monitoring by providing 3 registerable callbacks. onConnect() , onDisconnect() and onBind(NetworkStatus networkStatus).

##Adding to your project##

If you're using gradle all you need is this :

dependencies {
    compile "com.novoda.merlin:I_NEED_TO_UPLOAD_THIS:0.5"
}

####if you're not using gradle yet... (maven and jar setup)####

##Usecases##

####onConnect()####

When the network state changes from disconnected to connected and a successful host ping has completed.

Because you have just aquired a valid network connection, time to update stale data!

####onDisconnect()####

When the network state changes from connected to disconnected.

Because you probably want to tell the user they're now offline! or disable certain functionality until a reliable connection is available again.

####onBind(NetworkStatus networkStatus)####

When the MerlinService has binded, the current NetworkStatus is provided, although this is without pinging a host.

Because you may need to know the current state of the network before a network change occurs.

##Simple usage

Create Merlin (using Merlin.Builder())

merlin = new Merlin.Builder().withConnectableCallbacks().build(context);

Bind and unbind the service in your activity

@Override
protected void onResume() {
    super.onResume();
    merlin.bind();
}

@Override
protected void onPause() {
    super.onPause();
    merlin.unbind();
}

Register for callbacks

merlin.registerConnectable(new Connectable() {
        @Override
        public void onConnect() {
            // Do something!
        }
});

The MerlinActivity within the demo shows a simple way to declutter Merlin from your main application code.

##Changelog

###0.5###

• moved to gradle! - The api hasn't changed from v0.4.1 but building the project will now require gradle.

###0.4.1###

• added java doc to the MerlinBuilder
• added sources to the maven release
• added apache 2.0 license

###0.4###

• workaround for issue #4 which causes the Android Runtime to restart after uninstalling
• code tidying

###0.3-SNAPSHOT###

• quick release to get bug fix out
• Fixed issue #2

###0.2###

• Removed bindListener.
• Added bindable to match connectable and disconnectable.
• Tidied code up.

###0.2-SNAPSHOT###

• Initial release.

##Contributing!

If you would like to help out (and everyone should!!) please code against the develop branch

and be sure write tests where possible!

##License##

(c) Copyright 2014 Novoda

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.