Changeset 4657 for pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/account.hpp

Timestamp:

Nov 27, 2013 9:37:32 AM (11 years ago)

Author:

nanang

Message:

Re #1519: Added presence API in pjsua2.

File:

• pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/account.hpp (modified) (16 diffs)

pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/account.hpp

@@ -26 +26 @@
 #include <pjsua-lib/pjsua.h>
 #include <pjsua2/persistent.hpp>
+#include <pjsua2/presence.hpp>
 #include <pjsua2/siptypes.hpp>
 
@@ -913 +914 @@
 };
 
-/**
- * This describes account presence status.
- */
-struct AccountPresenceStatus
-{
-    /** Basic status. */
-    bool                isOnline;
-
-    /** Activity type. */
-    pjrpid_activity     activity;
-
-    /** Optional text describing the person/element. */
-    string              note;
-
-    /** Optional RPID ID string. */
-    string              rpidId;
-
-public:
-    AccountPresenceStatus();
-};
-
 
 /**
@@ -1071 +1051 @@
 {
     /**
+     * Server presence subscription instance. If application delays
+     * the acceptance of the request, it will need to specify this object
+     * when calling Account::presNotify().
+     */
+    void               *srvPres;
+
+    /**
      *  Sender URI.
      */
@@ -1220 +1207 @@
 };
 
+/**
+ * Parameters for presNotify() account method.
+ */
+struct PresNotifyParam
+{
+    /**
+     * Server presence subscription instance.
+     */
+    void               *srvPres;
+
+    /**
+     * Server presence subscription state to set.
+     */
+    pjsip_evsub_state   state;
+    
+    /**
+     * Optionally specify the state string name, if state is not "active",
+     * "pending", or "terminated".
+     */
+    string              stateStr;
+
+    /**
+     * If the new state is PJSIP_EVSUB_STATE_TERMINATED, optionally specify
+     * the termination reason.
+     */
+    string              reason;
+
+    /**
+     * If the new state is PJSIP_EVSUB_STATE_TERMINATED, this specifies
+     * whether the NOTIFY request should contain message body containing
+     * account's presence information.
+     */
+    bool                withBody;
+
+    /**
+     * Optional list of headers to be sent with the NOTIFY request.
+     */
+    SipTxOption         txOption;
+};
+
+
+/**
+ * Wrapper class for Buddy matching algo.
+ *
+ * Default algo is a simple substring lookup of search-token in the
+ * Buddy URIs, with case sensitive. Application can implement its own
+ * matching algo by overriding this class and specifying its instance
+ * in Account::findBuddy().
+ */
+class FindBuddyMatch
+{
+public:
+    /**
+     * Default algo implementation.
+     */
+    virtual bool match(const string &token, const Buddy &buddy)
+    {
+        BuddyInfo bi = buddy.getInfo();
+        return bi.uri.find(token) != string::npos;
+    }
+
+    /**
+     * Destructor.
+     */
+    virtual ~FindBuddyMatch() {}
+};
 
 /**
@@ -1332 +1385 @@
      * @param pres_st           Presence online status.
      */
-    void setOnlineStatus(const AccountPresenceStatus &pres_st) throw(Error);
+    void setOnlineStatus(const PresenceStatus &pres_st) throw(Error);
 
     /**
@@ -1350 +1403 @@
     void setTransport(TransportId tp_id) throw(Error);
 
+    /**
+     * Send NOTIFY to inform account presence status or to terminate server
+     * side presence subscription. If application wants to reject the incoming
+     * request, it should set the param \a PresNotifyParam.state to
+     * PJSIP_EVSUB_STATE_TERMINATED.
+     *
+     * @param prm               The sending NOTIFY parameter.
+     */
+    void presNotify(const PresNotifyParam &prm) throw(Error);
+    
+    /**
+     * Enumerate all buddies of the account.
+     *
+     * @return                  The buddy list.
+     */
+    const BuddyVector& enumBuddies() const throw(Error);
+
+    /**
+     * Find a buddy in the buddy list with the specified URI. 
+     *
+     * Exception: if buddy is not found, PJ_ENOTFOUND will be thrown.
+     *
+     * @param uri               The buddy URI.
+     * @param buddy_match       The buddy match algo.
+     *
+     * @return                  The pointer to buddy.
+     */
+    Buddy* findBuddy(string uri, FindBuddyMatch *buddy_match = NULL) const
+                    throw(Error);
+
+    /**
+     * An internal function to add a Buddy to Account buddy list.
+     * This function must never be used by application.
+     */
+    void addBuddy(Buddy *buddy);
+
+    /**
+     * An internal function to remove a Buddy from Account buddy list.
+     * This function must never be used by application.
+     */
+    void removeBuddy(Buddy *buddy);
+
 public:
     /*
@@ -1360 +1455 @@
      */
     virtual void onIncomingCall(OnIncomingCallParam &prm)
-    {}
+    { PJ_UNUSED_ARG(prm); }
 
     /**
@@ -1371 +1466 @@
      */
     virtual void onRegStarted(OnRegStartedParam &prm)
-    {}
+    { PJ_UNUSED_ARG(prm); }
 
     /**
@@ -1381 +1476 @@
      */
     virtual void onRegState(OnRegStateParam &prm)
-    {}
+    { PJ_UNUSED_ARG(prm); }
 
     /**
@@ -1403 +1498 @@
      *    user permission whether to accept or reject the request. In this
      *    case, the application MUST set the IncomingSubscribeParam.code
-     *    argument to 202, then IMMEDIATELY calls #pjsua_pres_notify() with
-     *    state PJSIP_EVSUB_STATE_PENDING and later calls #pjsua_pres_notify()
+     *    argument to 202, then IMMEDIATELY calls presNotify() with
+     *    state PJSIP_EVSUB_STATE_PENDING and later calls presNotify()
      *    again to accept or reject the subscription request.
      *
@@ -1416 +1511 @@
      */
     virtual void onIncomingSubscribe(OnIncomingSubscribeParam &prm)
-    {}
+    { PJ_UNUSED_ARG(prm); }
 
     /**
@@ -1425 +1520 @@
      */
     virtual void onInstantMessage(OnInstantMessageParam &prm)
-    {}
+    { PJ_UNUSED_ARG(prm); }
 
     /**
@@ -1434 +1529 @@
      */
     virtual void onInstantMessageStatus(OnInstantMessageStatusParam &prm)
-    {}
+    { PJ_UNUSED_ARG(prm); }
 
     /**
@@ -1442 +1537 @@
      */
     virtual void onTypingIndication(OnTypingIndicationParam &prm)
-    {}
+    { PJ_UNUSED_ARG(prm); }
 
     /**
@@ -1453 +1548 @@
      */
     virtual void onMwiInfo(OnMwiInfoParam &prm)
-    {}
+    { PJ_UNUSED_ARG(prm); }
 
 protected:
@@ -1461 +1556 @@
     pjsua_acc_id         id;
     string               tmpReason;     // for saving response's reason
+    BuddyVector          buddyList;
 };