zoidcom.h

Go to the documentation of this file.

/****************************************
* zoidcom.h
* ZoidCom main header
*
* This file is part of the "Zoidcom Automated Networking System" application library.
* Copyright (C)2002-2007 by Joerg Rueppel. See documentation for copyright and licensing details.
*****************************************/

#ifndef _ZOIDCOM_H_
#define _ZOIDCOM_H_

#include "zoidcom_prereq.h"

class ZoidCom_Private;

enum eZCom_SocketType
{
  eZCom_SocketLocal,
  eZCom_SocketTCP,
  eZCom_SocketUDP,
  eZCom_SocketCount
};

enum eZCom_BlockMode
{
  eZCom_Block,
  eZCom_NoBlock
};

enum eZCom_DependencyOpt
{
  eZCom_AddDependency,
  eZCom_RemoveDependency
};

enum eZCom_DiscoverOpt
{
  eZCom_DiscoverEnable,
  eZCom_DiscoverDisableAndKeep,
  eZCom_DiscoverDisable
};

enum eZCom_AddressType
{
  eZCom_AddressLocal,
  eZCom_AddressTCP,
  eZCom_AddressUDP,
  eZCom_AddressBroadcast
};

enum eZCom_GetIPAddressOption
{
  eZCom_AddressWithPort,
  eZCom_AddressWithoutPort
};

enum eZCom_ConnectResult
{
  eZCom_ConnAccepted,
  eZCom_ConnDenied,
  eZCom_ConnTimeout,
  eZCom_ConnHostnameFailed,
  eZCom_ConnWrongVersion
};

enum eZCom_CloseReason
{
  eZCom_ClosedDisconnect,
  eZCom_ClosedTimeout,
  eZCom_ClosedReconnect
};

enum eZCom_ZoidResult
{
  eZCom_ZoidEnabled,
  eZCom_ZoidDenied,
  eZCom_ZoidFailed_System,
  eZCom_ZoidFailed_Node,
  eZCom_ZoidDisabled
};

enum eZCom_HostnameResult
{
  eZCom_HostnameIdle,
  eZCom_HostnameFailed,
  eZCom_HostnameSuccess,
  eZCom_HostnameInProgress
};

enum eZCom_NodeRole
{
  eZCom_RoleUndefined,
  eZCom_RoleProxy,
  eZCom_RoleOwner,
  eZCom_RoleAuthority
};

enum eZCom_SendMode
{
  eZCom_ReliableUnordered,
  eZCom_ReliableOrdered,
  eZCom_Unreliable,
  eZCom_UnreliableNotify
};

enum eZCom_Event
{
  eZCom_EventNoEvent,

  /* system events */

  eZCom_EventInit,
  eZCom_EventSyncRequest,
  eZCom_EventRemoved,

  eZCom_EventFile_Incoming,
  eZCom_EventFile_Data,
  eZCom_EventFile_Aborted,
  eZCom_EventFile_Complete,

  /* replicator events */

  // replicator is sending some data through node event system (internal)
  eZCom_EventReplicator,

  /* normal events */

  eZCom_EventUser
};

typedef zU32 ZCom_ConnID;
typedef zU32 ZCom_ClassID;
typedef zU32 ZCom_NodeID;
typedef zU32 ZCom_FileTransID;
typedef zU32 ZCom_GroupID;
typedef zU8  ZCom_InterceptID;

const ZCom_ClassID ZCom_Invalid_ID = 0;

/***********************/
/* Connection Stats    */
/***********************/

struct ZCom_ConnStats
{
  zU32  last_in;
  zU32  last_out;
  zU32  last_sec_out, last_sec_in;
  zU32  last_sec_outp, last_sec_inp;
  zU32  current_out, current_in;
  zU32  current_outp, current_inp;
  zU32  total_out, total_in;
  zU32 last_interval_update;
  zU16  ping;
  zU16 avg_ping;
  zU8 last_sec_loss_percent;
  zU8 last_sec_loss_count;
  zU8 current_loss_count;
};

/***********************/
/* File transfer info  */
/***********************/

struct ZCom_FileTransInfo
{
  ZCom_FileTransID id;
  zU32 size;
  zU32 transferred;
  const char  *path;
  zU32 bps;
};

/* ===================================== */

class ZCOM_API ZoidCom
{
private:
  ZoidCom_Private *m_priv;
public:
  ZoidCom();
  ZoidCom( const char *_logfile );
  ZoidCom( void ( *_logfunc ) ( const char* ) );
  ~ZoidCom();

  /* init & exit */

  bool
    Init();

  void
    Clear( void );

  /* global setup */

  void
    setConnectionTimeout(zU32 _timeout);

  void
    setResendTimeout(zU32 _timeout);


  static void
    overrideMemoryHandlers(void*(*_allocator)(size_t _size), void(*_deallocator)(void *_ptr));

  void
    setLogLevel(zU8 _level);

  static zU32
    getTime();

  static void
    Sleep(zU32 _msecs);
};

#include "zoidcom_bitstream.h"
#include "zoidcom_address.h"
#include "zoidcom_control.h"
#include "zoidcom_node.h"
#include "zoidcom_node_interceptors.h"
#include "zoidcom_conngroup.h"
#include "zoidcom_replicator.h"
#include "zoidcom_replicator_basic.h"
#include "zoidcom_replicator_advanced.h"
#include "zoidcom_replicator_numeric.h"
#include "zoidcom_replicator_bool.h"
#include "zoidcom_replicator_memblock.h"
#include "zoidcom_replicator_string.h"
#include "zoidcom_replicator_interpolate.h"
#include "zoidcom_replicator_movement.h"

#endif

---