/protocols/ss7/m3ua/api/src/main/java/org/mobicents/protocols/ss7/m3ua/M3UASelectableChannel.java

http://mobicents.googlecode.com/ · Java · 46 lines · 5 code · 3 blank · 38 comment · 0 complexity · e44ce9f135d6ca66e781094a9f906dd7 MD5 · raw file

  1. /*
  2. * JBoss, Home of Professional Open Source
  3. * Copyright 2011, Red Hat, Inc. and individual contributors
  4. * by the @authors tag. See the copyright.txt in the distribution for a
  5. * full listing of individual contributors.
  6. *
  7. * This is free software; you can redistribute it and/or modify it
  8. * under the terms of the GNU Lesser General Public License as
  9. * published by the Free Software Foundation; either version 2.1 of
  10. * the License, or (at your option) any later version.
  11. *
  12. * This software is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15. * Lesser General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Lesser General Public
  18. * License along with this software; if not, write to the Free
  19. * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  20. * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
  21. */
  22. package org.mobicents.protocols.ss7.m3ua;
  23. import java.nio.channels.ClosedChannelException;
  24. /**
  25. * A channel that can be multiplexed via a M3UASelector.
  26. *
  27. * In order to be used with a selector, an instance of this class must first be registered via
  28. * the register method. This method returns a new M3UASelectionKey object that represents
  29. * the channel's registration with the selector.
  30. *
  31. * @author kulikov
  32. */
  33. public interface M3UASelectableChannel {
  34. /**
  35. * Registers this channel with the given selector, returning a selection key.
  36. *
  37. * @param selector The selector with which this channel is to be registered
  38. * @param ops The interest set for the resulting key
  39. * @return A key representing the registration of this channel with the given selector.
  40. * @throws java.nio.channels.ClosedChannelException
  41. */
  42. public M3UASelectionKey register(M3UASelector selector, int ops) throws ClosedChannelException;
  43. }