client.h

Go to the documentation of this file.

/***************************************************************************
 $RCSfile$
                             -------------------
    cvs         : $Id: client_p.h 137 2005-11-03 13:07:50Z aquamaniac $
    begin       : Mon Mar 01 2004
    copyright   : (C) 2004 by Martin Preuss
    email       : martin@libchipcard.de

 ***************************************************************************
 *          Please see toplevel file COPYING for license details           *
 ***************************************************************************/


#ifndef CHIPCARD_CLIENT_CLIENT_H
#define CHIPCARD_CLIENT_CLIENT_H



#include <gwenhywfar/inherit.h>
#include <chipcard3/chipcard3.h>


#ifdef __cplusplus
extern "C" {
#endif

#define LC_DEFAULT_SHORT_TIMEOUT     10
#define LC_DEFAULT_LONG_TIMEOUT      30
#define LC_DEFAULT_VERY_LONG_TIMEOUT 60

#define LC_CLIENT_TIMEOUT_NONE    0
#define LC_CLIENT_TIMEOUT_FOREVER (-1)


typedef struct LC_CLIENT LC_CLIENT;
GWEN_INHERIT_FUNCTION_LIB_DEFS(LC_CLIENT, CHIPCARD_API)



typedef enum {
  LC_Client_ResultOk=0,
  LC_Client_ResultWait,
  LC_Client_ResultIpcError,
  LC_Client_ResultCmdError,
  LC_Client_ResultDataError,
  LC_Client_ResultAborted,
  LC_Client_ResultInvalid,
  LC_Client_ResultInternal,
  LC_Client_ResultGeneric,
  LC_Client_ResultNoData,
  LC_Client_ResultCardRemoved,
  LC_Client_ResultNotSupported,
  LC_Client_ResultCfgError,
  LC_Client_ResultNotFound,
  LC_Client_ResultIoError,
  LC_Client_ResultBadPin
} LC_CLIENT_RESULT;


typedef enum {
  LC_Client_CmdTargetCard=0,
  LC_Client_CmdTargetReader
} LC_CLIENT_CMDTARGET;



#ifdef __cplusplus
}
#endif


#include <chipcard3/client/card.h>
#include <chipcard3/client/notifications.h>
#include <chipcard3/client/mon/monitor.h>
#include <chipcard3/client/switch.h>


#ifdef __cplusplus
extern "C" {
#endif

typedef void (*LC_CLIENT_RECV_NOTIFICATION_FN)(LC_CLIENT *cl,
                                               const LC_NOTIFICATION *n);




CHIPCARD_API
LC_CLIENT_RESULT LC_Client_Init(LC_CLIENT *cl);

CHIPCARD_API
LC_CLIENT_RESULT LC_Client_Fini(LC_CLIENT *cl);

CHIPCARD_API
LC_CLIENT_RESULT LC_Client_Start(LC_CLIENT *cl);

CHIPCARD_API
LC_CLIENT_RESULT LC_Client_Stop(LC_CLIENT *cl);

CHIPCARD_API
LC_CLIENT_RESULT LC_Client_GetNextCard(LC_CLIENT *cl,
                                       LC_CARD **pCard,
                                       int timeout);

/* This function releases the given card. After calling this function the card
 * can no longer be used for commands etc.
 * You should call @ref LC_Card_free on the card afterwards.
 */
CHIPCARD_API
LC_CLIENT_RESULT LC_Client_ReleaseCard(LC_CLIENT *cl, LC_CARD *card);

CHIPCARD_API
void LC_Client_free(LC_CLIENT *cl);

CHIPCARD_API
const char *LC_Client_GetIoTypeName(const LC_CLIENT *cl);

/*{@*/
CHIPCARD_API
const char *LC_Client_GetProgramName(const LC_CLIENT *cl);

CHIPCARD_API
const char *LC_Client_GetProgramVersion(const LC_CLIENT *cl);

CHIPCARD_API
int LC_Client_GetShortTimeout(const LC_CLIENT *cl);

CHIPCARD_API
int LC_Client_GetLongTimeout(const LC_CLIENT *cl);

CHIPCARD_API
int LC_Client_GetVeryLongTimeout(const LC_CLIENT *cl);
CHIPCARD_API
GWEN_XMLNODE *LC_Client_GetAppNodes(const LC_CLIENT *cl);

CHIPCARD_API
GWEN_XMLNODE *LC_Client_GetCardNodes(const LC_CLIENT *cl);

CHIPCARD_API
GWEN_DB_NODE *LC_Client_GetReaderConfig(const LC_CLIENT *cl,
                                        const char *reader);
CHIPCARD_API
LCM_MONITOR *LC_Client_GetMonitor(const LC_CLIENT *cl);

CHIPCARD_API
LC_CLIENT_RESULT LC_Client_SetNotify(LC_CLIENT *cl,
                                     GWEN_TYPE_UINT32 flags);

CHIPCARD_API
LC_CLIENT_RECV_NOTIFICATION_FN
LC_Client_SetRecvNotificationFn(LC_CLIENT *cl,
                                LC_CLIENT_RECV_NOTIFICATION_FN fn);
#ifdef __cplusplus
}
#endif


#endif /* CHIPCARD_CLIENT_CLIENT_H */

---