SipPresenceEvent.h

Go to the documentation of this file.

//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$

#ifndef _SipPresenceEvent_h_
#define _SipPresenceEvent_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include <utl/UtlHashMap.h>
#include <net/HttpBody.h>
#include <net/Url.h>
#include <os/OsDateTime.h>
#include <os/OsBSem.h>

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS

#define PRESENCE_EVENT_CONTENT_TYPE "application/pidf+xml"
#define PRESENCE_EVENT_TYPE "presence"

#define BEGIN_PRESENCE "<presence xmlns=\"urn:ietf:params:xml:ns:pidf\""
#define END_PRESENCE "</presence>\n"

#define PRESENTITY_EQUAL " entity="

#define BEGIN_TUPLE "<tuple id="
#define END_TUPLE "</tuple>\n"

#define BEGIN_STATUS "<status>\n"
#define END_STATUS "</status>\n"

#define BEGIN_BASIC "<basic>"
#define END_BASIC "</basic>\n"

#define BEGIN_CONTACT "<contact>"
#define END_CONTACT "</contact>\n"


#define STATUS_OPEN "open"
#define STATUS_CLOSED "closed"

// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS


class Tuple : public UtlContainable
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
  public:

   Tuple(const char* tupleId);

   Tuple(const Tuple& rTuple);

   ~Tuple();

   virtual UtlContainableType getContainableType() const;

   static const UtlContainableType TYPE;

   virtual unsigned int hash() const;

   int compareTo(const UtlContainable *b) const;

   
   void setTupleId(const char* tupleId);

   void getTupleId(UtlString& tupleId) const;

   void setStatus(const char* status);

   void getStatus(UtlString& state) const;

   void setContact(const char* url, const float priority);

   void getContact(UtlString& url, float& priority) const;

   
/* //////////////////////////// PROTECTED ///////////////////////////////// */
  protected:
   
/* //////////////////////////// PRIVATE /////////////////////////////////// */
  private:

   // Variables for tuple element
   UtlString mId;

   // Variables for status element
   UtlString mStatus;

   // Variables for contact element
   UtlString mContactUrl;
   float mPriority;

   //Assignment operator
   Tuple& operator=(const Tuple& rhs);
};



class SipPresenceEvent : public HttpBody
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
  public:

   SipPresenceEvent(const char* entity, const char* bodyBytes = NULL);

   virtual
      ~SipPresenceEvent();

   
   void buildBody() const;

   virtual int getLength() const;


   virtual void getBytes(const char** bytes,
                         int* length) const;


   virtual void getBytes(UtlString* bytes,
                         int* length) const;


   void insertTuple(Tuple* tuple);

   Tuple* getTuple(UtlString& tupleId);
   
   Tuple* removeTuple(Tuple* tuple);
   
   UtlBoolean isEmpty();

   
/* //////////////////////////// PROTECTED ///////////////////////////////// */
  protected:
   
   void parseBody(const char* bytes);


/* //////////////////////////// PRIVATE /////////////////////////////////// */
  private:

   UtlString mEntity;

   UtlHashMap mTuples;

    OsBSem mLock;

   SipPresenceEvent(const SipPresenceEvent& rSipPresenceEvent);

   SipPresenceEvent& operator=(const SipPresenceEvent& rhs);

};

/* ============================ INLINE METHODS ============================ */

#endif  // _SipPresenceEvent_h_