mw_st_list.h File Reference

Parse and compose buddy lists in the format commonly used by Sametime Connect clients. More...

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

Go to the source code of this file.

Macros
#define	ST_LIST_MAJOR   3
#define	ST_LIST_MICRO   3
#define	ST_LIST_MINOR   1

Enumerations
enum	mwSametimeGroupType {   mwSametimeGroup_NORMAL = 1 ,   mwSametimeGroup_DYNAMIC = 2 ,   mwSametimeGroup_UNKNOWN = 0 }
enum	mwSametimeUserType {   mwSametimeUser_NORMAL = 1 ,   mwSametimeUser_EXTERNAL = 2 ,   mwSametimeUser_UNKNOWN = 0 }

Functions
struct mwSametimeUser *	mwSametimeGroup_findUser (struct mwSametimeGroup *g, struct mwIdBlock *user)
void	mwSametimeGroup_free (struct mwSametimeGroup *g)
	Remove a group from its list, and free it.
const char *	mwSametimeGroup_getAlias (struct mwSametimeGroup *g)
struct mwSametimeList *	mwSametimeGroup_getList (struct mwSametimeGroup *g)
const char *	mwSametimeGroup_getName (struct mwSametimeGroup *g)
enum mwSametimeGroupType	mwSametimeGroup_getType (struct mwSametimeGroup *g)
GList *	mwSametimeGroup_getUsers (struct mwSametimeGroup *g)
	Get a GList snapshot of the users in a list.
gboolean	mwSametimeGroup_isOpen (struct mwSametimeGroup *g)
struct mwSametimeGroup *	mwSametimeGroup_new (struct mwSametimeList *l, enum mwSametimeGroupType type, const char *name)
	Create a new group in a list.
void	mwSametimeGroup_setAlias (struct mwSametimeGroup *g, const char *alias)
void	mwSametimeGroup_setOpen (struct mwSametimeGroup *g, gboolean open)
struct mwSametimeGroup *	mwSametimeList_findGroup (struct mwSametimeList *l, const char *name)
void	mwSametimeList_free (struct mwSametimeList *l)
	Free the list, all of its groups, and all of the groups' members.
void	mwSametimeList_get (struct mwGetBuffer *b, struct mwSametimeList *l)
	Load a sametime list from a buffer.
GList *	mwSametimeList_getGroups (struct mwSametimeList *l)
	Get a GList snapshot of the groups in a list.
guint	mwSametimeList_getMajor (struct mwSametimeList *l)
guint	mwSametimeList_getMicro (struct mwSametimeList *l)
guint	mwSametimeList_getMinor (struct mwSametimeList *l)
struct mwSametimeList *	mwSametimeList_load (const char *str)
	convert a plain string into a sametime list
struct mwSametimeList *	mwSametimeList_new (void)
	Create a new list.
void	mwSametimeList_put (struct mwPutBuffer *b, struct mwSametimeList *l)
	Write a sametime list onto a buffer.
void	mwSametimeList_setMajor (struct mwSametimeList *l, guint v)
void	mwSametimeList_setMicro (struct mwSametimeList *l, guint v)
void	mwSametimeList_setMinor (struct mwSametimeList *l, guint v)
char *	mwSametimeList_store (struct mwSametimeList *l)
	convert a sametime list into a string
void	mwSametimeUser_free (struct mwSametimeUser *u)
	Remove user from its group, and free it.
const char *	mwSametimeUser_getAlias (struct mwSametimeUser *u)
const char *	mwSametimeUser_getCommunity (struct mwSametimeUser *u)
struct mwSametimeGroup *	mwSametimeUser_getGroup (struct mwSametimeUser *u)
const char *	mwSametimeUser_getShortName (struct mwSametimeUser *u)
enum mwSametimeUserType	mwSametimeUser_getType (struct mwSametimeUser *u)
const char *	mwSametimeUser_getUser (struct mwSametimeUser *u)
struct mwSametimeUser *	mwSametimeUser_new (struct mwSametimeGroup *g, enum mwSametimeUserType type, struct mwIdBlock *user)
	Create a user in a group.
void	mwSametimeUser_setAlias (struct mwSametimeUser *u, const char *alias)
void	mwSametimeUser_setShortName (struct mwSametimeUser *u, const char *name)

Detailed Description

Parse and compose buddy lists in the format commonly used by Sametime Connect clients.

Macro Definition Documentation

ST_LIST_MAJOR

#define ST_LIST_MAJOR   3

ST_LIST_MICRO

#define ST_LIST_MICRO   3

ST_LIST_MINOR

#define ST_LIST_MINOR   1

Enumeration Type Documentation

mwSametimeGroupType

enum mwSametimeGroupType

Enumerator
mwSametimeGroup_NORMAL	a normal group of users
mwSametimeGroup_DYNAMIC	a server-side group
mwSametimeGroup_UNKNOWN	error determining group type

mwSametimeUserType

enum mwSametimeUserType

Enumerator
mwSametimeUser_NORMAL	user on same community
mwSametimeUser_EXTERNAL	external user
mwSametimeUser_UNKNOWN	error determining user type

Function Documentation

mwSametimeGroup_findUser()

struct mwSametimeUser * mwSametimeGroup_findUser	(	struct mwSametimeGroup *	g,
		struct mwIdBlock *	user )

References mwSametimeGroup_findUser().

Referenced by mwSametimeGroup_findUser().

mwSametimeGroup_free()

void mwSametimeGroup_free

(

struct mwSametimeGroup *

g

)

Remove a group from its list, and free it.

Also frees all users contained in the group

References mwSametimeGroup_free().

Referenced by mwSametimeGroup_free().

mwSametimeGroup_getAlias()

const char * mwSametimeGroup_getAlias

(

struct mwSametimeGroup *

g

)

References mwSametimeGroup_getAlias().

Referenced by mwSametimeGroup_getAlias().

mwSametimeGroup_getList()

struct mwSametimeList * mwSametimeGroup_getList

(

struct mwSametimeGroup *

g

)

References mwSametimeGroup_getList().

Referenced by mwSametimeGroup_getList().

mwSametimeGroup_getName()

const char * mwSametimeGroup_getName

(

struct mwSametimeGroup *

g

)

References mwSametimeGroup_getName().

Referenced by mwSametimeGroup_getName().

mwSametimeGroup_getType()

enum mwSametimeGroupType mwSametimeGroup_getType

(

struct mwSametimeGroup *

g

)

References mwSametimeGroup_getType().

Referenced by mwSametimeGroup_getType().

mwSametimeGroup_getUsers()

GList * mwSametimeGroup_getUsers

(

struct mwSametimeGroup *

g

)

Get a GList snapshot of the users in a list.

References mwSametimeGroup_getUsers().

Referenced by mwSametimeGroup_getUsers().

mwSametimeGroup_isOpen()

gboolean mwSametimeGroup_isOpen

(

struct mwSametimeGroup *

g

)

References mwSametimeGroup_isOpen().

Referenced by mwSametimeGroup_isOpen().

mwSametimeGroup_new()

struct mwSametimeGroup * mwSametimeGroup_new	(	struct mwSametimeList *	l,
		enum mwSametimeGroupType	type,
		const char *	name )

Create a new group in a list.

References mwSametimeGroup_new().

Referenced by mwSametimeGroup_new().

mwSametimeGroup_setAlias()

void mwSametimeGroup_setAlias	(	struct mwSametimeGroup *	g,
		const char *	alias )

References mwSametimeGroup_setAlias().

Referenced by mwSametimeGroup_setAlias().

mwSametimeGroup_setOpen()

void mwSametimeGroup_setOpen	(	struct mwSametimeGroup *	g,
		gboolean	open )

References mwSametimeGroup_setOpen().

Referenced by mwSametimeGroup_setOpen().

mwSametimeList_findGroup()

struct mwSametimeGroup * mwSametimeList_findGroup	(	struct mwSametimeList *	l,
		const char *	name )

References mwSametimeList_findGroup().

Referenced by mwSametimeList_findGroup().

mwSametimeList_free()

void mwSametimeList_free

(

struct mwSametimeList *

l

)

Free the list, all of its groups, and all of the groups' members.

References mwSametimeList_free().

Referenced by mwSametimeList_free().

mwSametimeList_get()

void mwSametimeList_get	(	struct mwGetBuffer *	b,
		struct mwSametimeList *	l )

Load a sametime list from a buffer.

The list must be encapsulated as a string (eg, the first two bytes in the buffer should be the length of the string)

References mwSametimeList_get().

Referenced by mwSametimeList_get().

mwSametimeList_getGroups()

GList * mwSametimeList_getGroups

(

struct mwSametimeList *

l

)

Get a GList snapshot of the groups in a list.

References mwSametimeList_getGroups().

Referenced by mwSametimeList_getGroups().

mwSametimeList_getMajor()

guint mwSametimeList_getMajor

(

struct mwSametimeList *

l

)

References mwSametimeList_getMajor().

Referenced by mwSametimeList_getMajor().

mwSametimeList_getMicro()

guint mwSametimeList_getMicro

(

struct mwSametimeList *

l

)

References mwSametimeList_getMicro().

Referenced by mwSametimeList_getMicro().

mwSametimeList_getMinor()

guint mwSametimeList_getMinor

(

struct mwSametimeList *

l

)

References mwSametimeList_getMinor().

Referenced by mwSametimeList_getMinor().

mwSametimeList_load()

struct mwSametimeList * mwSametimeList_load

(

const char *

str

)

convert a plain string into a sametime list

References mwSametimeList_load().

Referenced by mwSametimeList_load().

mwSametimeList_new()

struct mwSametimeList * mwSametimeList_new

(

void

)

Create a new list.

References mwSametimeList_new().

Referenced by mwSametimeList_new().

mwSametimeList_put()

void mwSametimeList_put	(	struct mwPutBuffer *	b,
		struct mwSametimeList *	l )

Write a sametime list onto a buffer.

The list will be encapsulated in a string (the first two bytes written will be the length of the rest of the written list data)

References mwSametimeList_put().

Referenced by mwSametimeList_put().

mwSametimeList_setMajor()

void mwSametimeList_setMajor	(	struct mwSametimeList *	l,
		guint	v )

References mwSametimeList_setMajor().

Referenced by mwSametimeList_setMajor().

mwSametimeList_setMicro()

void mwSametimeList_setMicro	(	struct mwSametimeList *	l,
		guint	v )

References mwSametimeList_setMicro().

Referenced by mwSametimeList_setMicro().

mwSametimeList_setMinor()

void mwSametimeList_setMinor	(	struct mwSametimeList *	l,
		guint	v )

References mwSametimeList_setMinor().

Referenced by mwSametimeList_setMinor().

mwSametimeList_store()

char * mwSametimeList_store

(

struct mwSametimeList *

l

)

convert a sametime list into a string

References mwSametimeList_store().

Referenced by mwSametimeList_store().

mwSametimeUser_free()

void mwSametimeUser_free

(

struct mwSametimeUser *

u

)

Remove user from its group, and free it.

References mwSametimeUser_free().

Referenced by mwSametimeUser_free().

mwSametimeUser_getAlias()

const char * mwSametimeUser_getAlias

(

struct mwSametimeUser *

u

)

References mwSametimeUser_getAlias().

Referenced by mwSametimeUser_getAlias().

mwSametimeUser_getCommunity()

const char * mwSametimeUser_getCommunity

(

struct mwSametimeUser *

u

)

References mwSametimeUser_getCommunity().

Referenced by mwSametimeUser_getCommunity().

mwSametimeUser_getGroup()

struct mwSametimeGroup * mwSametimeUser_getGroup

(

struct mwSametimeUser *

u

)

References mwSametimeUser_getGroup().

Referenced by mwSametimeUser_getGroup().

mwSametimeUser_getShortName()

const char * mwSametimeUser_getShortName

(

struct mwSametimeUser *

u

)

References mwSametimeUser_getShortName().

Referenced by mwSametimeUser_getShortName().

mwSametimeUser_getType()

enum mwSametimeUserType mwSametimeUser_getType

(

struct mwSametimeUser *

u

)

References mwSametimeUser_getType().

Referenced by mwSametimeUser_getType().

mwSametimeUser_getUser()

const char * mwSametimeUser_getUser

(

struct mwSametimeUser *

u

)

References mwSametimeUser_getUser().

Referenced by mwSametimeUser_getUser().

mwSametimeUser_new()

struct mwSametimeUser * mwSametimeUser_new	(	struct mwSametimeGroup *	g,
		enum mwSametimeUserType	type,
		struct mwIdBlock *	user )

Create a user in a group.

References mwSametimeUser_new().

Referenced by mwSametimeUser_new().

mwSametimeUser_setAlias()

void mwSametimeUser_setAlias	(	struct mwSametimeUser *	u,
		const char *	alias )

References mwSametimeUser_setAlias().

Referenced by mwSametimeUser_setAlias().

mwSametimeUser_setShortName()

void mwSametimeUser_setShortName	(	struct mwSametimeUser *	u,
		const char *	name )

References mwSametimeUser_setShortName().

Referenced by mwSametimeUser_setShortName().