tdmessage.h

Go to the documentation of this file.

/*
 *  $Id: tdmessage.h 1259 2011-12-17 13:26:09Z dreibh $
 *
 * SocketAPI implementation for the sctplib.
 * Copyright (C) 1999-2012 by Thomas Dreibholz
 *
 * Realized in co-operation between
 * - Siemens AG
 * - University of Essen, Institute of Computer Networking Technology
 * - University of Applied Sciences, Muenster
 *
 * Acknowledgement
 * This work was partially funded by the Bundesministerium fuer Bildung und
 * Forschung (BMBF) of the Federal Republic of Germany (Foerderkennzeichen 01AK045).
 * The authors alone are responsible for the contents.
 *
 * This program is free software: you can redistribute it 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/>.
 *
 * Contact: discussion@sctp.de
 *          dreibh@iem.uni-due.de
 *          tuexen@fh-muenster.de
 *
 * Purpose: Socket Message
 *
 */



#ifndef TDMESSAGE_H
#define TDMESSAGE_H


#include "tdsystem.h"
#include "socketaddress.h"


#include <sys/uio.h>
#include <sys/types.h>
#include <sys/socket.h>


inline static size_t CSpace(const size_t payloadLength);

inline static size_t CLength(const size_t payloadLength);


inline static void* CData(cmsghdr* cmsg);

inline static cmsghdr* CFirstHeader(msghdr* header);

inline static cmsghdr* CNextHeader(msghdr* header, const cmsghdr* cmsg);


inline static const void* CData(const cmsghdr* cmsg);

inline static const cmsghdr* CFirstHeader(const msghdr* header);

inline static const cmsghdr* CNextHeader(const msghdr* header, const cmsghdr* cmsg);


template<const size_t size> class SocketMessage
{
   // ====== Constructor ====================================================
   public:
   inline SocketMessage();


   // ====== Structure manipulation =========================================
   inline void clear();

   inline SocketAddress* getAddress() const;

   inline void setAddress(const SocketAddress& address,
                          const integer        family = AF_UNSPEC);

   inline void setBuffer(void* buffer, const size_t buffersize);

   inline void* addHeader(const size_t payloadLength,
                          const int    level,
                          const int    type);

   inline cmsghdr* getFirstHeader();

   inline cmsghdr* getNextHeader(cmsghdr* prev);

   inline int getFlags() const;

   inline void setFlags(const int flags);

   // ====== Message structures =============================================
   msghdr Header;

   sockaddr_storage Address;

   struct iovec IOVector;

   private:
   cmsghdr* NextMsg;

   public:
#ifdef SOLARIS
   char Control[_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + _CMSG_DATA_ALIGN(size)];
#else
   char Control[CMSG_SPACE(size)];
#endif
};


#include "tdmessage.icc"


#endif