0
0
mirror of https://github.com/cjdelisle/cjdns synced 2025-10-06 00:32:50 +02:00
Files
cjdns/interface/FramingIface.h
Casper Ti. Vector 2298997092 Manual merge 79a60b9
2020-09-18 22:08:23 +02:00

39 lines
1.4 KiB
C

/* vim: set expandtab ts=4 sw=4: */
/*
* You may redistribute this program and/or modify it under the terms of
* the GNU General Public License as published by the Free Software Foundation,
* either version 3 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, see <https://www.gnu.org/licenses/>.
*/
#ifndef FramingIface_H
#define FramingIface_H
#include "interface/Iface.h"
#include "memory/Allocator.h"
#include "util/Linker.h"
Linker_require("interface/FramingIface.c")
/**
* Framed message format:
* [4 bytes length][ <length> bytes content ....... ]
* The length is of only the content, not including the beginning 4 bytes
* which represents the length itself.
*
* @param maxMessageSize how large of a framed message to allow
* @param wrappedIface the stream interface which will be used to
* communicate framed messages to a peer.
* @param alloc
*/
struct Iface* FramingIface_new(uint32_t maxMessageSize,
struct Iface* wrappedIface,
struct Allocator* alloc);
#endif