diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2c46422 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +# Eclipse files +.project +.classpath + +# Generated and compiled stuff +bin/ +gen/ + diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..53fc032 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +Android Network Intents +======================= +Android Network Intents (ANI) is a library to send Android Intent objects to listening +apps/devices via multicast (UDP). This library has been written to utilize it for +writing simple app or service discovery protocols but as it can be used to send and +receive any Intents through the network without knowing the specific receivers there +might be a lot of other use cases. + +Developed by +============ + +* Sebastian Kaspari + +License +======= + + Copyright 2013 Sebastian Kaspari + + 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. + diff --git a/library/src/main/java/com/androidzeitgeist/networkintent/discovery/Discovery.java b/library/src/main/java/com/androidzeitgeist/networkintent/discovery/Discovery.java new file mode 100644 index 0000000..fba599c --- /dev/null +++ b/library/src/main/java/com/androidzeitgeist/networkintent/discovery/Discovery.java @@ -0,0 +1,135 @@ +/* + * Copyright (C) 2013 Sebastian Kaspari + * + * 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. + */ + +package com.androidzeitgeist.networkintent.discovery; + +import android.content.Intent; + +import com.androidzeitgeist.networkintent.internal.AndroidNetworkIntents; + +/** + * Discovery class for receiving {@link Intent}s from the network. + * + * @author Sebastian Kaspari + */ +public class Discovery { + private String multicastAddress; + private int port; + + private DiscoveryListener listener; + private DiscoveryThread thread; + + /** + * Create a new {@link Discovery} instance that will listen to the default + * multicast address and port for incoming {@link Intent}s. + */ + public Discovery() { + this( + AndroidNetworkIntents.DEFAULT_MULTICAST_ADDRESS, + AndroidNetworkIntents.DEFAULT_PORT + ); + } + + /** + * Create a new {@link Discovery} instance that will listen to the default + * multicast address and the given port for incoming {@link Intent}s. + * + * @param port The network port to listen to. + */ + public Discovery(int port) { + this( + AndroidNetworkIntents.DEFAULT_MULTICAST_ADDRESS, + port + ); + } + + /** + * Create a new {@link Discovery} instance that will listen to the given + * multicast address and port for incoming {@link Intent}s. + * + * @param multicastAddress The multicast address to listen to, e.g. 225.4.5.6. + * @param port The port to listen to. + */ + public Discovery(String multicastAddress, int port) { + this.multicastAddress = multicastAddress; + this.port = port; + } + + /** + * Set the {@link DiscoveryListener} instance that will be notified about + * incoming {@link Intent}s. + * + * @param listener The {@link DiscoveryListener} that will be notified about + * incoming {@link Intent}s. + */ + public void setDisoveryListener(DiscoveryListener listener) { + this.listener = listener; + } + + /** + * Enables the {@link Discovery} so that it will monitor the network for + * {@link Intent}s and notify the given {@link DiscoveryListener} instance. + * + * This is a shortcut for: + * + * discovery.setDiscoveryListener(listener); + * discovery.enable(); + * + * + * @param listener The {@link DiscoveryListener} that will be notified about + * incoming {@link Intent}s. + * @throws DiscoveryException + */ + public void enable(DiscoveryListener listener) throws DiscoveryException { + setDisoveryListener(listener); + enable(); + } + + /** + * Enables the {@link Discovery} so that it will monitor the network for + * {@link Intent}s and notify the set {@link DiscoveryListener} instance. + * + * @throws DiscoveryException + * @throws {@link IllegalStateException} if no listener has been set + * @throws IllegalAccessError if this {@link Discovery} is already enabled + */ + public void enable() throws DiscoveryException { + if (listener == null) { + throw new IllegalStateException("No listener set"); + } + + if (thread == null) { + thread = new DiscoveryThread(multicastAddress, port, listener); + thread.start(); + } else { + throw new IllegalAccessError("Discovery already started"); + } + } + + /** + * Disables the {@link Discovery}. + * + * @throws IllegalAccessError if this {@link Discovery} is not running + */ + public void disable() { + if (thread != null) { + thread.stopDiscovery(); + thread = null; + } else { + throw new IllegalAccessError("Discovery not running"); + } + } +} diff --git a/library/src/main/java/com/androidzeitgeist/networkintent/discovery/DiscoveryAdapter.java b/library/src/main/java/com/androidzeitgeist/networkintent/discovery/DiscoveryAdapter.java new file mode 100644 index 0000000..6654f86 --- /dev/null +++ b/library/src/main/java/com/androidzeitgeist/networkintent/discovery/DiscoveryAdapter.java @@ -0,0 +1,50 @@ +package com.androidzeitgeist.networkintent.discovery; + +import android.content.Intent; + +/** + * This adapter class provides empty implementations of the methods from + * {@link DiscoveryListener}. + * + * Any custom listener that cares only about a subset of the methods of this listener + * can simply subclass this adapter class instead of implementing the interface + * directly. + * + * @author Sebastian Kaspari + */ +public abstract class DiscoveryAdapter implements DiscoveryListener { + /** + * Called when the {@link Discovery} has successfully received an {@link Intent}. + * + * @param intent The received {@link Intent}. + */ + public abstract void onIntentDiscovered(Intent intent); + + /** + * The {@link Discovery} has been started and is now waiting for incoming + * {@link Intent}s. + * + * Empty default implementation. + */ + public void onDiscoveryStarted() { + // Empty default implementation + } + + /** + * The {@link Discovery} has been stopped. + * + * Empty default implementation. + */ + public void onDiscoveryStopped() { + // Empty default implementation + } + + /** + * An unrecoverable error occured. The {@link Discovery} is going to be stopped. + * + * Empty default implementation. + */ + public void onDiscoveryError() { + // Empty default implementation + } +} diff --git a/library/src/main/java/com/androidzeitgeist/networkintent/discovery/DiscoveryException.java b/library/src/main/java/com/androidzeitgeist/networkintent/discovery/DiscoveryException.java new file mode 100644 index 0000000..e2bea36 --- /dev/null +++ b/library/src/main/java/com/androidzeitgeist/networkintent/discovery/DiscoveryException.java @@ -0,0 +1,37 @@ +/* + * Copyright (C) 2013 Sebastian Kaspari + * + * 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. + */ + +package com.androidzeitgeist.networkintent.discovery; + +/** + * Wrapper exception for all kind of low level exceptions that can be thrown by + * the implementation of the {@link Discovery} class. + * + * @author Sebastian Kaspari + */ +@SuppressWarnings("serial") +public class DiscoveryException extends Exception { + /** + * Constructs a new {@link DiscoveryException} with the current stack trace, the + * specified detail message and the specified cause. + * + * @param detailMessage the detail message for this exception. + * @param cause the cause of this exception. + */ + public DiscoveryException(String detailMessage, Exception cause) { + super(detailMessage, cause); + } +} diff --git a/library/src/main/java/com/androidzeitgeist/networkintent/discovery/DiscoveryListener.java b/library/src/main/java/com/androidzeitgeist/networkintent/discovery/DiscoveryListener.java new file mode 100644 index 0000000..bc4e8bb --- /dev/null +++ b/library/src/main/java/com/androidzeitgeist/networkintent/discovery/DiscoveryListener.java @@ -0,0 +1,51 @@ +/* + * Copyright (C) 2013 Sebastian Kaspari + * + * 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. + */ + +package com.androidzeitgeist.networkintent.discovery; + +import android.content.Intent; + +/** + * A {@link DiscoveryListener} receives notifications from a {@link Discovery}. + * Notifications indicate lifecycle related events as well as successfully received + * {@link Intent}s. + * + * @author Sebastian Kaspari + */ +public interface DiscoveryListener { + /** + * The {@link Discovery} has been started and is now waiting for incoming + * {@link Intent}s. + */ + public void onDiscoveryStarted(); + + /** + * The {@link Discovery} has been stopped. + */ + public void onDiscoveryStopped(); + + /** + * An unrecoverable error occured. The {@link Discovery} is going to be stopped. + */ + public void onDiscoveryError(); + + /** + * Called when the {@link Discovery} has successfully received an {@link Intent}. + * + * @param intent The received {@link Intent}. + */ + public void onIntentDiscovered(Intent intent); +} diff --git a/library/src/main/java/com/androidzeitgeist/networkintent/discovery/DiscoveryThread.java b/library/src/main/java/com/androidzeitgeist/networkintent/discovery/DiscoveryThread.java new file mode 100644 index 0000000..b9c26ed --- /dev/null +++ b/library/src/main/java/com/androidzeitgeist/networkintent/discovery/DiscoveryThread.java @@ -0,0 +1,121 @@ +/* + * Copyright (C) 2013 Sebastian Kaspari + * + * 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. + */ + +package com.androidzeitgeist.networkintent.discovery; + +import java.io.IOException; +import java.net.DatagramPacket; +import java.net.InetAddress; +import java.net.MulticastSocket; +import java.net.URISyntaxException; +import java.net.UnknownHostException; + +import android.content.Intent; +import android.util.Log; + +/** + * Internal class for handling the network connection of the {@link Discovery} class + * on a background thread. + * + * @author Sebastian Kaspari + */ +class DiscoveryThread extends Thread { + private static final String TAG = "ANI/DiscoveryThread"; + private static final int MAXIMUM_PACKET_BYTES = 102400; + + private String multicastAddress; + private int port; + private MulticastSocket socket; + private DiscoveryListener listener; + + private volatile boolean running; + + /** + * Create a new background thread that handles incoming Intents on the given + * multicast address and port. + * + * Do not instantiate this class yourself. Use the {@link Discovery} class + * instead. + * + * @param multicastAddress + * @param port + * @param listener + */ + /* package-private */ DiscoveryThread(String multicastAddress, int port, DiscoveryListener listener) { + this.multicastAddress = multicastAddress; + this.port = port; + this.listener = listener; + } + + public void run() { + running = true; + + listener.onDiscoveryStarted(); + + try { + createSocket(); + receiveIntents(); + } catch(IOException exception) { + listener.onDiscoveryError(); + } finally { + closeSocket(); + } + + listener.onDiscoveryStopped(); + } + + private void createSocket() throws UnknownHostException, IOException { + InetAddress address = InetAddress.getByName(multicastAddress); + + socket = new MulticastSocket(port); + socket.joinGroup(address); + } + + private void closeSocket() { + if (socket != null) { + socket.close(); + } + } + + public void stopDiscovery() { + running = false; + + closeSocket(); + } + + public void receiveIntents() throws IOException { + while (running) { + DatagramPacket packet = new DatagramPacket( + new byte[MAXIMUM_PACKET_BYTES], MAXIMUM_PACKET_BYTES + ); + + try { + socket.receive(packet); + + byte[] data = packet.getData(); + int length = packet.getLength(); + + String intentUri = new String(data, 0, length); + Intent intent = Intent.parseUri(intentUri, 0); + + listener.onIntentDiscovered(intent); + + } catch (URISyntaxException exception) { + Log.v(TAG, "Received UDP packet that could not be parsed as Intent"); + } + } + } +} diff --git a/library/src/main/java/com/androidzeitgeist/networkintent/internal/AndroidNetworkIntents.java b/library/src/main/java/com/androidzeitgeist/networkintent/internal/AndroidNetworkIntents.java new file mode 100644 index 0000000..5798915 --- /dev/null +++ b/library/src/main/java/com/androidzeitgeist/networkintent/internal/AndroidNetworkIntents.java @@ -0,0 +1,28 @@ +/* + * Copyright (C) 2013 Sebastian Kaspari + * + * 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. + */ + +package com.androidzeitgeist.networkintent.internal; + +/** + * Internal class for implementation specific constants. + * + * @author Sebastian Kaspari + */ +public class AndroidNetworkIntents { + public static final String DEFAULT_MULTICAST_ADDRESS = "225.4.5.6"; + + public static final int DEFAULT_PORT = 5775; +} diff --git a/library/src/main/java/com/androidzeitgeist/networkintent/transmitter/Transmitter.java b/library/src/main/java/com/androidzeitgeist/networkintent/transmitter/Transmitter.java new file mode 100644 index 0000000..9f14d97 --- /dev/null +++ b/library/src/main/java/com/androidzeitgeist/networkintent/transmitter/Transmitter.java @@ -0,0 +1,124 @@ +/* + * Copyright (C) 2013 Sebastian Kaspari + * + * 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. + */ + +package com.androidzeitgeist.networkintent.transmitter; + +import java.io.IOException; +import java.net.DatagramPacket; +import java.net.InetAddress; +import java.net.MulticastSocket; +import java.net.SocketException; +import java.net.UnknownHostException; + +import android.content.Intent; + +import com.androidzeitgeist.networkintent.discovery.Discovery; +import com.androidzeitgeist.networkintent.internal.AndroidNetworkIntents; + +/** + * Transmitter class for sending {@link Intent}s through network. + * + * @author Sebastian Kaspari + */ +public class Transmitter { + private String multicastAddress; + private int port; + + /** + * Creates a new {@link Transmitter} instance that will sent {@link Intent}s to + * the default multicast address and port. + */ + public Transmitter() { + this( + AndroidNetworkIntents.DEFAULT_MULTICAST_ADDRESS, + AndroidNetworkIntents.DEFAULT_PORT + ); + } + + /** + * Creates a new {@link Transmitter} instance that will sent {@link Intent}s to + * the default multicast address and the given port port. + * + * @param The destination network port. + */ + public Transmitter(int port) { + this( + AndroidNetworkIntents.DEFAULT_MULTICAST_ADDRESS, + port + ); + } + + /** + * Creates a new {@link Transmitter} instance that will sent {@link Intent}s to + * the given multicast address and port. + * + * @param multicastAddress The destination multicast address, e.g. 225.4.5.6. + * @param port The destination network port. + */ + public Transmitter(String multicastAddress, int port) { + this.multicastAddress = multicastAddress; + this.port = port; + } + + /** + * Sends an {@link Intent} through the network to any listening {@link Discovery} + * instance. + * + * @param intent The intent to send. + * @throws TransmitterException + */ + public void transmit(Intent intent) throws TransmitterException { + MulticastSocket socket = null; + + try { + socket = new MulticastSocket(); + transmit(socket, intent); + } catch (UnknownHostException exception) { + throw new TransmitterException("Unknown host", exception); + } catch (SocketException exception) { + throw new TransmitterException("Can't create DatagramSocket", exception); + } catch (IOException exception) { + throw new TransmitterException("IOException during sending intent", exception); + } finally { + if (socket != null) { + socket.close(); + } + } + } + + /** + * Actual (private) implementation that serializes the {@link Intent} and sends + * it as {@link DatagramPacket}. Used to separate the implementation from the + * error handling code. + * + * @param socket + * @param intent + * @throws UnknownHostException + * @throws IOException + */ + private void transmit(MulticastSocket socket, Intent intent) throws UnknownHostException, IOException { + byte[] data = intent.toUri(0).getBytes(); + + DatagramPacket packet = new DatagramPacket( + data, + data.length, + InetAddress.getByName(multicastAddress), + port + ); + + socket.send(packet); + } +} diff --git a/library/src/main/java/com/androidzeitgeist/networkintent/transmitter/TransmitterException.java b/library/src/main/java/com/androidzeitgeist/networkintent/transmitter/TransmitterException.java new file mode 100644 index 0000000..d9559c1 --- /dev/null +++ b/library/src/main/java/com/androidzeitgeist/networkintent/transmitter/TransmitterException.java @@ -0,0 +1,37 @@ +/* + * Copyright (C) 2013 Sebastian Kaspari + * + * 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. + */ + +package com.androidzeitgeist.networkintent.transmitter; + +/** + * Wrapper exception for all kind of low level exceptions that can be thrown by + * the implementation of the {@link Transmitter} class. + * + * @author Sebastian Kaspari + */ +@SuppressWarnings("serial") +public class TransmitterException extends Exception { + /** + * Constructs a new {@link TransmitterException} with the current stack trace, the + * specified detail message and the specified cause. + * + * @param detailMessage the detail message for this exception. + * @param cause the cause of this exception. + */ + public TransmitterException(String detailMessage, Throwable cause) { + super(detailMessage, cause); + } +}