dnxProtocol.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------

   Copyright (c) 2006-2007, Intellectual Reserve, Inc. All rights reserved.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License version 2 as
   published by the Free Software Foundation.

   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, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  --------------------------------------------------------------------------*/

#ifndef _DNXPROTOCOL_H_
#define _DNXPROTOCOL_H_

#include <time.h>

#include "dnxTransport.h"

typedef enum DnxObjType
{
   DNX_OBJ_SCHEDULER = 0,
   DNX_OBJ_DISPATCHER,
   DNX_OBJ_WORKER,
   DNX_OBJ_COLLECTOR,
   DNX_OBJ_REAPER,
   DNX_OBJ_JOB,
   DNX_OBJ_MANAGER,
   DNX_OBJ_MAX
} DnxObjType;

typedef enum DnxReqType
{
   DNX_REQ_REGISTER = 0,
   DNX_REQ_DEREGISTER,
   DNX_REQ_ACK,
   DNX_REQ_NAK
} DnxReqType;

typedef enum DnxJobState
{
   DNX_JOB_NULL = 0,
   DNX_JOB_PENDING,
   DNX_JOB_INPROGRESS,
   DNX_JOB_COMPLETE,
   DNX_JOB_EXPIRED
} DnxJobState;

typedef struct DnxXID
{
   DnxObjType objType;              
   unsigned long objSerial;         
   unsigned long objSlot;           
} DnxXID;

typedef struct DnxNodeRequest
{
   DnxXID xid;                      
   DnxReqType reqType;              
   unsigned int jobCap;             
   unsigned int ttl;                
   time_t expires;                  
   char address[DNX_MAX_ADDRESS];   
   char addrstr[DNX_MAX_ADDRSTR];   
} DnxNodeRequest;

typedef struct DnxJob
{
   DnxXID xid;                      
   DnxJobState state;               
   int priority;                    
   int timeout;                     
   char * cmd;                      
   char address[DNX_MAX_ADDRESS];   
} DnxJob;

typedef struct DnxResult
{
   DnxXID xid;                      
   DnxJobState state;               
   unsigned int delta;              
   int resCode;                     
   char * resData;                  
   char address[DNX_MAX_ADDRESS];   
} DnxResult;

typedef struct DnxMgmtRequest
{
   DnxXID xid;                      
   char * action;                   
   char address[DNX_MAX_ADDRESS];   
} DnxMgmtRequest;

typedef struct DnxMgmtReply
{
   DnxXID xid;                      
   DnxReqType status;               
   char * reply;                    
   char address[DNX_MAX_ADDRESS];   
} DnxMgmtReply;

int dnxSendMgmtRequest(DnxChannel * channel, DnxMgmtRequest * pRequest);

int dnxSendMgmtReply(DnxChannel * channel, DnxMgmtReply * pReply, 
      char * address);

int dnxWaitForMgmtReply(DnxChannel * channel, DnxMgmtReply * pReply, 
      int timeout);

int dnxWaitForMgmtRequest(DnxChannel * channel, DnxMgmtRequest * pRequest,
      char * address, int timeout);

int dnxMakeXID(DnxXID * pxid, DnxObjType xType, unsigned long xSerial, 
      unsigned long xSlot);

int dnxEqualXIDs(DnxXID * pxa, DnxXID * pxb);

#endif   /* _DNXPROTOCOL_H_ */