mw_service.h

Go to the documentation of this file.

/*
  Meanwhile - Unofficial Lotus Sametime Community Client Library
  Copyright (C) 2004  Christopher (siege) O'Brien
  
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.
  
  This library 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
  Library General Public License for more details.
  
  You should have received a copy of the GNU Library General Public
  License along with this library; if not, write to the Free
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef _MW_SERVICE_H
#define _MW_SERVICE_H


#include "mw_common.h"


#ifdef __cplusplus
extern "C" {
#endif


/* place-holders */
struct mwChannel;
struct mwService;
struct mwSession;
struct mwMsgChannelCreate;
struct mwMsgChannelAccept;
struct mwMsgChannelDestroy;


enum mwServiceState {
  mwServiceState_STOPPED,   
  mwServiceState_STOPPING,  
  mwServiceState_STARTED,   
  mwServiceState_STARTING,  
  mwServiceState_ERROR,     
  mwServiceState_UNKNOWN,   
};


#define MW_SERVICE(srv) ((struct mwService *) srv)


#define MW_SERVICE_IS_STATE(srvc, state) \
  (mwService_getState(MW_SERVICE(srvc)) == (state))

#define MW_SERVICE_IS_STOPPED(srvc)  \
  MW_SERVICE_IS_STATE(srvc, mwServiceState_STOPPED)

#define MW_SERVICE_IS_STOPPING(srvc) \
  MW_SERVICE_IS_STATE(srvc, mwServiceState_STOPPING)

#define MW_SERVICE_IS_STARTED(srvc)  \
  MW_SERVICE_IS_STATE(srvc, mwServiceState_STARTED)

#define MW_SERVICE_IS_STARTING(srvc) \
  MW_SERVICE_IS_STATE(srvc, mwServiceState_STARTING)


#define MW_SERVICE_IS_LIVE(srvc) \
  (MW_SERVICE_IS_STARTING(srvc) || MW_SERVICE_IS_STARTED(srvc))

#define MW_SERVICE_IS_DEAD(srvc) \
  (MW_SERVICE_IS_STOPPING(srvc) || MW_SERVICE_IS_STOPPED(srvc))


typedef void (*mwService_funcStart)(struct mwService *service);

typedef void (*mwService_funcStop)(struct mwService *service);

typedef void (*mwService_funcClear)(struct mwService *service);

typedef const char *(*mwService_funcGetName)(struct mwService *service);

typedef const char *(*mwService_funcGetDesc)(struct mwService *service);

typedef void (*mwService_funcRecvCreate)
     (struct mwService *service,
      struct mwChannel *channel,
      struct mwMsgChannelCreate *msg);

typedef void (*mwService_funcRecvAccept)
     (struct mwService *service,
      struct mwChannel *channel,
      struct mwMsgChannelAccept *msg);

typedef void (*mwService_funcRecvDestroy)
     (struct mwService *service,
      struct mwChannel *channel,
      struct mwMsgChannelDestroy *msg);

typedef void (*mwService_funcRecv)
     (struct mwService *service,
      struct mwChannel *channel,
      guint16 msg_type,
      struct mwOpaque *data);


struct mwService {

  guint32 type;

  enum mwServiceState state;

  struct mwSession *session;

  mwService_funcGetName get_name;

  mwService_funcGetDesc get_desc;

  mwService_funcRecvCreate recv_create;

  mwService_funcRecvAccept recv_accept;

  mwService_funcRecvDestroy recv_destroy;

  mwService_funcRecv recv;

  mwService_funcStart start;

  mwService_funcStop stop;
  
  mwService_funcClear clear;

  gpointer client_data;

  GDestroyNotify client_cleanup;
};




void mwService_init(struct mwService *service,
                    struct mwSession *session,
                    guint32 service_type);


void mwService_started(struct mwService *service);


void mwService_stopped(struct mwService *service);




void mwService_recvCreate(struct mwService *service,
                          struct mwChannel *channel,
                          struct mwMsgChannelCreate *msg);


void mwService_recvAccept(struct mwService *service,
                          struct mwChannel *channel,
                          struct mwMsgChannelAccept *msg);


void mwService_recvDestroy(struct mwService *service,
                           struct mwChannel *channel,
                           struct mwMsgChannelDestroy *msg);


void mwService_recv(struct mwService *service,
                    struct mwChannel *channel,
                    guint16 msg_type,
                    struct mwOpaque *data);


guint32 mwService_getType(struct mwService *);


const char *mwService_getName(struct mwService *);


const char *mwService_getDesc(struct mwService *);


struct mwSession *mwService_getSession(struct mwService *service);


enum mwServiceState mwService_getState(struct mwService *service);


void mwService_start(struct mwService *service);


void mwService_stop(struct mwService *service);


void mwService_free(struct mwService *service);


void mwService_setClientData(struct mwService *service,
                             gpointer data, GDestroyNotify cleanup);


gpointer mwService_getClientData(struct mwService *service);


void mwService_removeClientData(struct mwService *service);


#ifdef __cplusplus
}
#endif


#endif /* _MW_SERVICE_H */