FramingIface.h 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. /* vim: set expandtab ts=4 sw=4: */
  2. /*
  3. * You may redistribute this program and/or modify it under the terms of
  4. * the GNU General Public License as published by the Free Software Foundation,
  5. * either version 3 of the License, or (at your option) any later version.
  6. *
  7. * This program is distributed in the hope that it will be useful,
  8. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. * GNU General Public License for more details.
  11. *
  12. * You should have received a copy of the GNU General Public License
  13. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  14. */
  15. #ifndef FramingIface_H
  16. #define FramingIface_H
  17. #include "interface/Iface.h"
  18. #include "memory/Allocator.h"
  19. #include "util/Linker.h"
  20. Linker_require("interface/FramingIface.c")
  21. /**
  22. * Framed message format:
  23. * [4 bytes length][ <length> bytes content ....... ]
  24. * The length is of only the content, not including the beginning 4 bytes
  25. * which represents the length itself.
  26. *
  27. * @param maxMessageSize how large of a framed message to allow
  28. * @param wrappedIface the stream interface which will be used to
  29. * communicate framed messages to a peer.
  30. * @param alloc
  31. */
  32. struct Iface* FramingIface_new(uint32_t maxMessageSize,
  33. struct Iface* wrappedIface,
  34. struct Allocator* alloc);
  35. #endif