cjdns/interface/FramingInterface.h

/* 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 <http://www.gnu.org/licenses/>.
 */
#ifndef FramingInterface_H
#define FramingInterface_H

#include "interface/Interface.h"
#include "memory/Allocator.h"
#include "util/Linker.h"
Linker_require("interface/FramingInterface.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 Interface* FramingInterface_new(uint32_t maxMessageSize,
                                       struct Interface* wrappedIface,
                                       struct Allocator* alloc);

#endif