vlInetSocketUtils.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
*********************************************************************/
#pragma once

#include <vlutil/vlInet.h>
#include <vlutil/vlInetSocket.h>

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

namespace DtInetUtils
{

// Each unique destination a socket sends to needs its own outbound bundle
// entry. The first value in the pair is the current number of bytes in all
// the buffer chains in the bundle. This eliminates the need to calculate the
// size of the bundle each time it's accessed.
typedef std::pair<DtU32, DtInetBufferChain> DtInetChainEntry;
typedef std::map<DtInetEndpoint, DtInetChainEntry> DtInetSockOutboundBundleMap;

// The inbound bundle queue needs to store each bundle received in the order 
// received with the source endpoint in case the application retrieving the
// the packets wants to know the source. So rather than storing inbound bundles
// separated by source endpoint a single queue is appropriate.
typedef std::pair<DtInetEndpoint, DtInetBuffer*> DtInetSockInboundBundleEntry;
typedef std::deque<DtInetSockInboundBundleEntry> DtInetSockInboundBundleQueue;

typedef struct DtInetPktHeaderDescriptor
{
   DtNetU8  sizeFieldOffset; // bytes from start of packet
   int sizeFieldLength; // in bytes. Valid values: 1 (DtU8), 2 (DtU16), 4 (DtU32)
   int sizeFieldMask;   // bitmask applied to size field

} DtInetPktHeaderDescriptor;
#define DtInetSockPacketHeader_MASK_NONE  0x00
#define DtInetSockPacketHeader_MASK_DtU8  0xff
#define DtInetSockPacketHeader_MASK_DtU16 0xffff
#define DtInetSockPacketHeader_MASK_DtU32 0xffffffff
// The default RTI header descriptor: offset = 0, length = 4, bitmask = MASK_DtU32
#define DtInetSockDefaultPktHdrDesc { 0, 4, DtInetSockPacketHeader_MASK_DtU32 }

#if 0
// STOPPED HERE --- move to socket subclass header
// | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 
// | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 
// v v v v v v v v v v v v v v v v v v v v v v v v v v v v v v v v v v v
   // Pre- and post-processing method utility members and functions 
   DtInetSockPktHdrDesc myHeaderDesc;
   int                  myBytesNeeded;
   bool                 myWaitingForStartOfPacket;

   virtual bool setHeaderDescriptor( DtInetSockPktHdrDesc& hdrDesc );
   virtual DtInetSockPktHdrDesc& getHeaderDescriptor() const;

   virtual bool  setMaxBacklogSize( DtU32 size );
   virtual DtU32 getMaxBacklogSize();

   DtInetUtils::DtInetSockOutboundBundleMap  myOutboundBacklogs;
   DtU32                                     myMaxBacklogSize;
   DtInetUtils::DtInetSockOutboundBundleMap  myOutboundBundles;
   DtU32                                     myMaxBundleSize;


// ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
// | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 
// | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 
// STOPPED HERE --- move to socket subclass header

// STOPPED HERE --- move to socket subclass implementation
// | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 
// | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 
// v v v v v v v v v v v v v v v v v v v v v v v v v v v v v v v v v v v
bool DtInetSocket::setHeaderDescriptor( DtInetSockPktHdrDesc& hdrDesc )
{
   if ( (hdrDesc.sizeFieldLength != 0) && (hdrDesc.sizeFieldLength != 1)
     && (hdrDesc.sizeFieldLength != 2) && (hdrDesc.sizeFieldLength != 4) )
   {
      return false;
   }

   // Initialize packet demultiplexing vars. 
   myHeaderDesc.sizeFieldOffset = hdrDesc.sizeFieldOffset;
   myHeaderDesc.sizeFieldLength = hdrDesc.sizeFieldLength;
   myHeaderDesc.sizeFieldMask = hdrDesc.sizeFieldMask;
   myBytesNeeded = myHeaderDesc.sizeFieldOffset + myHeaderDesc.sizeFieldLength;
   if ( hdrDesc.sizeFieldLength != 0 )
   {
      myWaitingForStartOfPacket = true;
   }
   else
   {
      myWaitingForStartOfPacket = false;
   }
   return true;
}

DtInetSockPktHdrDesc& DtInetSocket::getHeaderDescriptor() const
{
   return (DtInetSockPktHdrDesc&)myHeaderDesc;
}

bool DtInetSocket::setMaxBundleSize( DtU32 size )
{
   myMaxBundleSize = size;
// STOPPED HERE
   if ( size > 0 )
   {
      // Add default bundling pre- and post- processing callbacks. Bundling
      // should happen fairly early 
      addProcessingCallback( DtInetSockProcess_PRE_SEND,
                              DtInetSocket::addToBundle, cbPriority );
   }
   else
   {
      // Try to remove default bundling pre- and post- processing callbacks.
      // They may have been replaced by custom bundling callbacks, in which
      // case they won't be found, but that's not a problem.

   }
   return true;
}

DtU32 DtInetSocket::getMaxBundleSize()
{
   return myMaxBundleSize;
}

bool DtInetSocket::isBundling()
{
   return (myMaxBundleSize > 0);
}

bool DtInetSocket::setMaxBacklogSize( DtU32 size, int cbPriority )
{
   myMaxBacklogSize = size;
   if ( size > 0 )
   {
      // Add default backlog pre- and post- processing callbacks
   }
   else
   {
      // Try to remove default bundling pre- and post- processing callbacks.
      // They may have been replaced by custom backlog callbacks, in which
      // case they won't be found, but that's not a problem.

   }
   return true;
}

DtU32 DtInetSocket::getMaxBacklogSize()
{
   return myMaxBacklogSize;
}
// ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
// | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 
// | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 
// STOPPED HERE --- move to socket subclass implementation

#endif // 0

int DtInetSockUtilAddToBundle( DtInetSocket* sock, int size,
                           DtInetBufferChain& buffChain, DtInetEndpoint& ep,
                           void* usr );
int DtInetSockUtilFlushBundle( DtInetSocket* sock, int size,
                           DtInetBufferChain& buffChain, DtInetEndpoint& ep, 
                           void* usr );
int DtInetSockUtilUnbundle( DtInetSocket* sock, int size,
                        DtInetBufferChain& buffChain, DtInetEndpoint& ep, 
                        void* usr );

int DtInetSockUtilQueueBacklog( DtInetSocket* sock, int size,
                            DtInetBufferChain& buffChain, DtInetEndpoint& ep, 
                            void* usr );
int DtInetSockUtilFlushBacklog( DtInetSocket* sock, int size,
                            DtInetBufferChain& buffChain, DtInetEndpoint& ep, 
                            void* usr );

} 

#ifdef DtUSE_UTILITIES_NAMESPACE
} 
#endif