/protocols/ss7/mtp/mtp-impl/src/main/java/org/mobicents/protocols/ss7/mtp/Mtp1.java

http://mobicents.googlecode.com/ · Java · 91 lines · 13 code · 11 blank · 67 comment · 0 complexity · 5530531ee345c6a53962a5b7594dcf80 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.mtp;
  23. import java.io.IOException;
  24. import org.mobicents.protocols.stream.api.Stream;
  25. /**
  26. * @author baranowb
  27. * @author kulikov
  28. */
  29. public interface Mtp1 extends Stream {
  30. // FIXME: Oleg what's that?
  31. /**
  32. * Gets the code of this channel.
  33. *
  34. * @return the code of this channel.
  35. */
  36. public int getCode();
  37. /**
  38. * Set MTP2 layer serving this MTP1
  39. *
  40. * @param link
  41. */
  42. public void setLink(Object link);
  43. /**
  44. * Get MTP2 layer serving this MTP1
  45. *
  46. * @return
  47. */
  48. public Object getLink();
  49. /**
  50. * Fetches implementation dependent IO Buffer size which should be used
  51. *
  52. * @return integer number, Mtp2 implementation should assign buffers of this
  53. * size to interact with Mtp1
  54. */
  55. public int getIOBufferSize();
  56. /**
  57. * Reads up to buffer.length bytes from layer 1.
  58. *
  59. * @param buffer
  60. * reader buffer
  61. * @return the number of actually read bytes.
  62. */
  63. public int read(byte[] buffer) throws IOException;
  64. /**
  65. * Writes data to layer 1.
  66. *
  67. * @param buffer
  68. * the buffer containing data to write.
  69. * @param bytesToWrite
  70. */
  71. public void write(byte[] buffer, int bytesToWrite) throws IOException;
  72. /**
  73. * Open message transfer part layer 1.
  74. */
  75. public void open() throws IOException;
  76. /**
  77. * Close message transfer part layer 1.
  78. */
  79. public void close();
  80. }