• Home
• com.github.mrstampy
• KitchenSync
• 1.0
• source code
• KiSyMulticastChannel.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github.mrstampy.kitchensync.netty.channel.KiSyMulticastChannel Maven / Gradle / Ivy

/*
 * KitchenSync Java Library Copyright (C) 2014 Burton Alexander
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later
 * version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * 
 */
package com.github.mrstampy.kitchensync.netty.channel;

import io.netty.channel.ChannelFuture;

import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.NetworkInterface;

/**
 * {@link KiSyChannel} implementations interface the Netty specifics, allowing ease of socket creation
 * and use. Multicast channel implementations provide additional methods which
 * are specific to multicast channels.

 * 

 * 
 * KitchenSync multicast channels use IPv6 addresses.
 * Ranges and uses can be found at the IPv6 Multicast Address Space Registry
 */
public interface KiSyMulticastChannel extends KiSyChannel {

	/**
	 * Broadcast a message to the multicast channel. If {@link #joinGroup()} has
	 * been called the message will appear on this channel.
	 *
	 * @param 
	 *          the generic type
	 * @param message
	 *          the message
	 * @return the channel future
	 */
	 ChannelFuture broadcast(MSG message);

	/**
	 * Join the multicast group to receive broadcast messages sent to this
	 * address.
	 *
	 * @return true, if join group
	 */
	boolean joinGroup();

	/**
	 * Leave group to stop receiving broadcast messages..
	 *
	 * @return true, if leave group
	 */
	boolean leaveGroup();

	/**
	 * Gets the multicast address.
	 *
	 * @return the multicast address
	 */
	InetSocketAddress getMulticastAddress();

	/**
	 * Gets the network interface.
	 *
	 * @return the network interface
	 */
	NetworkInterface getNetworkInterface();

	/**
	 * Blocks messages from the specified source.
	 * 
	 * @param sourceToBlock
	 * @return true if successful
	 */
	boolean block(InetAddress sourceToBlock);
}