mw_channel.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_CHANNEL_H
#define _MW_CHANNEL_H


#include <time.h>
#include "mw_common.h"


#ifdef __cplusplus
extern "C" {
#endif


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



struct mwChannel;


struct mwChannelSet;


#define MW_MASTER_CHANNEL_ID  0x00000000


#define mwChannel_idIsOutgoing(id) \
  (! (0x80000000 & (id)))

#define mwChannel_idIsIncoming(id) \
  (! mwChannel_idIsOutgoing(id))

#define mwChannel_isOutgoing(chan) \
  mwChannel_idIsOutgoing(mwChannel_getId(chan))

#define mwChannel_isIncoming(chan) \
  mwChannel_idIsIncoming(mwChannel_getId(chan))


enum mwChannelState {
  mwChannel_NEW,      
  mwChannel_INIT,     
  mwChannel_WAIT,     
  mwChannel_OPEN,     
  mwChannel_DESTROY,  
  mwChannel_ERROR,    
  mwChannel_UNKNOWN,  
};


#define mwChannel_isState(chan, state) \
  (mwChannel_getState(chan) == (state))


enum mwChannelStatField {
  mwChannelStat_MSG_SENT,      
  mwChannelStat_MSG_RECV,      
  mwChannelStat_U_BYTES_SENT,  
  mwChannelStat_U_BYTES_RECV,  
  mwChannelStat_OPENED_AT,     
  mwChannelStat_CLOSED_AT,     
};


enum mwEncryptPolicy {
  mwEncrypt_NONE      = 0x0000, 
  mwEncrypt_WHATEVER  = 0x0001, 
  mwEncrypt_ALL       = 0x0002, 
  mwEncrypt_RC2_40    = 0x1000, 
  mwEncrypt_RC2_128   = 0x2000, 
};


struct mwChannelSet *mwChannelSet_new(struct mwSession *);


void mwChannelSet_free(struct mwChannelSet *);


struct mwChannel *mwChannel_newIncoming(struct mwChannelSet *, guint32 id);


struct mwChannel *mwChannel_newOutgoing(struct mwChannelSet *);


struct mwChannel *mwChannel_find(struct mwChannelSet *cs, guint32 chan);


guint32 mwChannel_getId(struct mwChannel *);


struct mwSession *mwChannel_getSession(struct mwChannel *);


guint32 mwChannel_getServiceId(struct mwChannel *);


struct mwService *mwChannel_getService(struct mwChannel *);


void mwChannel_setService(struct mwChannel *chan, struct mwService *srvc);


gpointer mwChannel_getServiceData(struct mwChannel *chan);


void mwChannel_setServiceData(struct mwChannel *chan,
                              gpointer data, GDestroyNotify clean);


void mwChannel_removeServiceData(struct mwChannel *chan);


guint32 mwChannel_getProtoType(struct mwChannel *chan);


void mwChannel_setProtoType(struct mwChannel *chan, guint32 proto_type);


guint32 mwChannel_getProtoVer(struct mwChannel *chan);


void mwChannel_setProtoVer(struct mwChannel *chan, guint32 proto_ver);


guint16 mwChannel_getEncryptPolicy(struct mwChannel *chan);


guint32 mwChannel_getOptions(struct mwChannel *chan);


void mwChannel_setOptions(struct mwChannel *chan, guint32 options);


struct mwLoginInfo *mwChannel_getUser(struct mwChannel *chan);


struct mwOpaque *mwChannel_getAddtlCreate(struct mwChannel *);


struct mwOpaque *mwChannel_getAddtlAccept(struct mwChannel *);


void mwChannel_populateSupportedCipherInstances(struct mwChannel *chan);


void mwChannel_addSupportedCipherInstance(struct mwChannel *chan,
                                          struct mwCipherInstance *ci);


GList *mwChannel_getSupportedCipherInstances(struct mwChannel *chan);


void mwChannel_selectCipherInstance(struct mwChannel *chan,
                                    struct mwCipherInstance *ci);


struct mwCipherInstance *
mwChannel_getCipherInstance(struct mwChannel *chan);


enum mwChannelState mwChannel_getState(struct mwChannel *);


gpointer mwChannel_getStatistic(struct mwChannel *chan,
                                enum mwChannelStatField stat);


int mwChannel_create(struct mwChannel *chan);


int mwChannel_accept(struct mwChannel *chan);


int mwChannel_destroy(struct mwChannel *chan, guint32 reason,
                      struct mwOpaque *data);


int mwChannel_send(struct mwChannel *chan, guint32 msg_type,
                   struct mwOpaque *msg);


int mwChannel_sendEncrypted(struct mwChannel *chan,
                            guint32 msg_type, struct mwOpaque *msg,
                            gboolean encrypt);


void mwChannel_recvCreate(struct mwChannel *chan,
                          struct mwMsgChannelCreate *msg);


void mwChannel_recvAccept(struct mwChannel *chan,
                          struct mwMsgChannelAccept *msg);


void mwChannel_recvDestroy(struct mwChannel *chan,
                           struct mwMsgChannelDestroy *msg);


void mwChannel_recv(struct mwChannel *chan, struct mwMsgChannelSend *msg);


#ifdef __cplusplus
}
#endif


#endif /* _MW_CHANNEL_H */