io.h

/*
 *  libFreiburg - src/LibFreiburg/include/msgque/io.h
 *  
 *  (C) 2004 - Freiburg - Project - Group
 *  ------------------------------------------------------
 *  EMail: freiburg AT compiler-factory DOT de
 *  ------------------------------------------------------
 *  all rights reserved
 */

#ifndef MQ_IO_H
#define MQ_IO_H

/* ####################################################################### */
/* ###                                                                 ### */
/* ###                           I O - A P I                           ### */
/* ###                                                                 ### */
/* ####################################################################### */

/*****************************************************************************/
/*                                                                           */
/*                                 io_misc                                   */
/*                                                                           */
/*****************************************************************************/

typedef enum { IO_UDS, IO_TCP } MqIoComE;
typedef enum { IO_COM, IO_N_TCP, IO_N_UDS, IO_N_GENERIC } MqIoOptE;
typedef enum { TCP_HOST, TCP_PORT } MqTcpOptE;
typedef enum { UDS_FILE } MqUdsOptE;
typedef enum { GENERIC_ID, GENERIC_BUFFERSIZE, GENERIC_SOERROR,
  GENERIC_INETD
} MqGenericOptE;

MQ_EXTERN MQ_PTR MqIoGetOpt (
  MqIoSP const io,              
  MqIoOptE opt,                 
  MQ_INT2 opt2                  
);

#define MqIoGetId(io)           ((MQ_STR)MqIoGetOpt(io,IO_N_GENERIC,GENERIC_ID))

#define MqIoGetCom(io)          (*((MqIoComE*)MqIoGetOpt(io,IO_COM,0)))

#define MqIoGetInted(io)        (*((MQ_INT2*)MqIoGetOpt(io,IO_N_GENERIC,GENERIC_INETD)))

#define MqIoGetBufferSize(io)   (*((MQ_INT4*)MqIoGetOpt(io,IO_N_GENERIC,GENERIC_BUFFERSIZE)))

/* ####################################################################### */
/* ###                                                                 ### */
/* ###                        R E A D - A P I                          ### */
/* ###                                                                 ### */
/* ####################################################################### */

/*****************************************************************************/
/*                                                                           */
/*                                read_reference                             */
/*                                                                           */
/*****************************************************************************/

MQ_EXTERN void MqReadCreate_LST_Ref (
  MqReadSP const in,
  const MqBufferSP buf,
  MqReadSP *out
);

MQ_EXTERN void MqReadDelete_LST_Ref (
  MqReadSP *readP
);

MQ_EXTERN void MqReadCreate_RET_Ref (
  MqReadSP const in,
  MqReadSP *out
);

MQ_EXTERN void MqReadDelete_RET_Ref (
  MqReadSP *readP
);

/*****************************************************************************/
/*                                                                           */
/*                                read_native                                */
/*                                                                           */
/*****************************************************************************/

MQ_EXTERN MqErrorE MqReadRET (
  MqReadSP const read,
  MqBufferSP const buf
);

/*****************************************************************************/
/*                                                                           */
/*                                read_atom                                  */
/*                                                                           */
/*****************************************************************************/

MQ_EXTERN MqErrorE MqReadU (
  MqReadSP const read,
  MqBufferSP *out
);

MQ_EXTERN void MqReadUDecr (
  MqReadSP const read,
  const MqBufferSP buf
);

MQ_EXTERN MqErrorE MqRead2 (
  MqReadSP const read,
  MQ_INT2 *out
);

MQ_EXTERN MqErrorE MqRead4 (
  MqReadSP const read,
  MQ_INT4 *out
);

MQ_EXTERN MqErrorE MqRead8 (
  MqReadSP const read,
  MQ_INT8 *out
);

MQ_EXTERN MqErrorE MqReadF (
  MqReadSP const read,
  MQ_FLT4 *out
);

MQ_EXTERN MqErrorE MqReadD (
  MqReadSP const read,
  MQ_FLT8 *out
);

MQ_EXTERN MqErrorE MqReadP (
  MqReadSP const read,
  MQ_PTR *out
);

MQ_EXTERN MqErrorE MqReadC (
  MqReadSP const read,
  MQ_STR *out
);

MQ_EXTERN MqErrorE MqReadArgv (
  MqReadSP const read,          
  int *argc,                    
  char ***argv                  
);

/*****************************************************************************/
/*                                                                           */
/*                                read_high                                  */
/*                                                                           */
/*****************************************************************************/

MQ_EXTERN inline MQ_SIZE MqReadGetNumItems (
  MqReadSP const read
);

MQ_EXTERN char MqReadGetReturnCode (
  MqReadSP const read
);

MQ_EXTERN inline MQ_INT2 MqReadGetReturnNum (
  MqReadSP const read
);

MQ_EXTERN inline MqSP MqReadGetMsgque (
  MqReadSP const read
);
/* ####################################################################### */
/* ###                                                                 ### */
/* ###                        S E N D - A P I                          ### */
/* ###                                                                 ### */
/* ####################################################################### */

/*****************************************************************************/
/*                                                                           */
/*                              send_atom                                    */
/*                                                                           */
/*****************************************************************************/

MQ_EXTERN inline void MqSendC (
  MqSendSP const send,
  const MQ_STR in
);

MQ_EXTERN void MqSendV (
  MqSendSP const send,
  const char *fmt,
  ...
);

MQ_EXTERN inline void MqSendVL (
  MqSendSP const send,
  const char *fmt,
  va_list ap
);

MQ_EXTERN void MqSend2 (
  MqSendSP const send,
  const MQ_INT2 in
);

MQ_EXTERN void MqSend4 (
  MqSendSP const send,
  const MQ_INT4 in
);

MQ_EXTERN void MqSend8 (
  MqSendSP const send,
  const MQ_INT8 in
);

MQ_EXTERN void MqSendF (
  MqSendSP const send,
  const MQ_FLT4 in
);

MQ_EXTERN void MqSendD (
  MqSendSP const send,
  const MQ_FLT8 in
);

MQ_EXTERN void MqSendP (
  MqSendSP const send,
  const MQ_PTR in
);

MQ_EXTERN void MqSendB (
  MqSendSP const send,
  const MQ_BIN in,
  const MQ_SIZE len
);

MQ_EXTERN void MqSendU (
  MqSendSP send,
  const MqBufferSP buf
);

/*****************************************************************************/
/*                                                                           */
/*                            send_header_value                              */
/*                                                                           */
/*****************************************************************************/

MQ_EXTERN inline void MqSendH2 (
  register MqSendSP const send,
  const MQ_STR header,
  const MQ_INT2 value
);

MQ_EXTERN inline void MqSendH4 (
  register MqSendSP const send,
  const MQ_STR header,
  const MQ_INT4 value
);

MQ_EXTERN inline void MqSendH8 (
  register MqSendSP const send,
  const MQ_STR header,
  const MQ_INT8 value
);

MQ_EXTERN inline void MqSendHF (
  register MqSendSP const send,
  const MQ_STR header,
  const MQ_FLT4 value
);

MQ_EXTERN inline void MqSendHD (
  register MqSendSP const send,
  const MQ_STR header,
  const MQ_FLT8 value
);

MQ_EXTERN inline void MqSendHP (
  register MqSendSP const send,
  const MQ_STR header,
  const MQ_PTR value
);

MQ_EXTERN inline void MqSendHC (
  register MqSendSP const send,
  const MQ_STR header,
  const MQ_STR value
);

/*****************************************************************************/
/*                                                                           */
/*                              send_compose                                 */
/*                                                                           */
/*****************************************************************************/

MQ_EXTERN void MqSendSTART (
  MqSendSP const send
);

MQ_EXTERN inline MqErrorE MqSendEND_RETR (
  MqSendSP const send,
  MqTransSP const trans
);

MQ_EXTERN MqErrorE MqSendEND (
  MqSendSP const send,
  const MQ_STR token,
  MqTransSP const trans
);

MQ_EXTERN MqErrorE MqSendEND_AND_WAIT (
  MqSendSP const send,
  const MQ_STR token,
  const time_t timeout
);

MQ_EXTERN MqErrorE MqSendRETURN (
  MqSendSP const send,
  const char *const fmt,
  const char *const proc
);

MQ_EXTERN MqErrorE MqSendOK (
  MqSendSP const send
);

MQ_EXTERN MqErrorE MqSendPING (
  MqSendSP const send
);

/*****************************************************************************/
/*                                                                           */
/*                              send_list                                    */
/*                                                                           */
/*****************************************************************************/

MQ_EXTERN void MqSend_LST_START (
  MqSendSP const send
);

MQ_EXTERN void MqSend_LST_END (
  MqSendSP const send
);

/*****************************************************************************/
/*                                                                           */
/*                               send_RET                                    */
/*                                                                           */
/*****************************************************************************/

MQ_EXTERN void MqSend_RET_START (
  MqSendSP const send,
  const char code,
  const MQ_INT4 num
);

MQ_EXTERN void MqSend_RET_END (
  MqSendSP const send
);

MQ_EXTERN void MqSend_RET_OK (
  MqSendSP const send
);

#endif /* MQ_IO_H */

---