ptaddress.h

基于sipfoundy 公司开发的sipx协议API

   virtual PtStatus removeCallListener(PtCallListener& rCallListener);
     //:Removes the indicated PtCallListener from this PtAddress.
     // This method removes a PtCallListener which was added via the
     // PtAddress.addCallListener() method. If successful, the listener will
     // no longer be added to new calls which are presented to this address,
     // however it does not affect PtCallListeners which have already been
     // added to a call.
     //!param: (in) rCallListener - the listener to remove
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_NOT_FOUND - <i>rCallListener</i> not registered
     //!retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

   virtual PtStatus removeAddressListener(PtAddressListener& rAddressListener);
     //:Removes the indicated listener from this PtAddress.
     //!param: (in) rAddressListener - the listener to remove from this address
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_NOT_FOUND - <i>rAddressListener</i> not registered
     //!retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

   virtual PtStatus setDoNotDisturb(PtBoolean flag);
     //:Specifies whether the <i>do-not-disturb</i> feature should be
     //:activated or deactivated for this address.
     //!param: (in) flag - TRUE ==> enable, FALSE ==> disable
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

   virtual PtStatus setForwarding(PtAddressForwarding forwards[], int size);
     //:Sets the forwarding characteristics for this address.
     //!param: (in) forwards - the array of call forwarding instructions
     //!param: (in) size - the number of forwarding instructions in the <i>forwards</i> array
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

   virtual PtStatus setMessageWaiting(PtBoolean flag);
     //:Specifies whether the <i>message-waiting</i> indicator should be
     //:activated or deactivated for this address.
     //!param: (in) flag - TRUE ==> on, FALSE ==> off
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

   virtual PtStatus setOfferedTimeout(int milliSecs);
     //:Specifies the timeout value for transitioning from the
     //:PtConnection::OFFERED state to the PtConnection::ALERTING state for
     //:an incoming call to this address.
     // If <i>milliSecs</i> is 0, a PtConnection in the PtConnection::OFFERED
     // state will immediately transition to the PtConnection::ALERTING state.
     // If <i>milliSecs</i> is greater than 0, the connection will stay in
     // the PtConnection::OFFERED state for the indicated number of
     // milliseconds or until the connection is explicitly handled (by calling
     // PtConnection.accept(), PtConnection.reject() or
     // PtConnection.redirect()). whichever comes first.  If the timeout
     // expires before the connection is explicitly handled, the connection
     // will then transition into the PtConnection::ALERTING state.  Setting
     // <i>milliSecs</i> to -1, is equivalent to requesting an infinite
     // timeout.
     //!param: (in) milliSecs - number of milliseconds to delay
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

/* ============================ ACCESSORS ================================= */

   virtual PtStatus getAddressListeners(PtAddressListener* addrListeners[],
                                int size, int& nItems);
     //:Returns an array of PtAddressListener pointers for all of the
     //:address listeners presently associated with this address.
     // The caller provides an array that can hold up to <i>size</i>
     // PtAddressListener pointers.  This method will fill in the
     // <i>addrListeners</i> array with up to <i>size</i> pointers.  The
     // actual number of pointers filled in is passed back via the
     // <i>nItems</i> argument.
     //!param: (out) addrListeners - the array of pointers to known address listeners
     //!param: (in) size - the number of elements in the <i>addrListeners</i> array
     //!param: (out) nItems - the number of items assigned
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_MORE_DATA - there are more than <i>size</i> listeners
     //!retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

   virtual PtStatus getCallListeners(PtCallListener* callListeners[], int size,
                             int& nItems);
     //:Returns an array of PtCallListener pointers for all of the call
     //:listeners presently associated with this address.
     // The caller provides an array that can hold up to <i>size</i>
     // PtCallListener pointers.  This method will fill in the
     // <i>callListeners</i> array with up to <i>size</i> pointers.  The
     // actual number of pointers filled in is passed back via the
     // <i>nItems</i> argument.
     //!param: (out) callListeners - the array of pointers to known call listeners
     //!param: (in) size - the number of elements in the <i>callListeners</i> array
     //!param: (out) nItems - the number of items assigned
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_MORE_DATA - there are more than <i>size</i> listeners
     //!retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

   virtual PtStatus getConnections(PtConnection connections[], int size,
                           int& nItems);
     //:Returns an array of pointers to PtConnection objects currently
     //:associated with this address.
     // The caller provides an array that can hold up to <i>size</i>
     // PtConnection pointers.  This method will fill in the
     // <i>connections</i> array with up to <i>size</i> pointers.  The
     // actual number of pointers filled in is passed back via the
     // <i>nItems</i> argument.
     //!param: (out) connections - the array of PtConnection pointers
     //!param: (in) size - the number of elements in the <i>connections</i> array
     //!param: (out) nItems - the number of items assigned
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_MORE_DATA - there are more than <i>size</i> connections
     //!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

   virtual PtStatus getDoNotDisturb(PtBoolean& rFlag);
     //:Returns the current setting for the <i>do-not-disturb</i> feature.
     //!param: (out) rFlag - TRUE ==> enabled, FALSE ==> disabled
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

   virtual PtStatus getForwarding(PtAddressForwarding forwards[], int size,
                          int& nItems);
     //:Returns an array of forwarding instructions currently associated with
     //:this address.
     // The caller provides an array of PtAddressForwarding objects containing
     // <i>size</i> elements.  This method will fill in the <i>forwards</i>
     // array with up to <i>size</i> objects.  The actual number of items
     // filled in is passed back via the <i>nItems</i> argument.
     //!param: (out) forwards - The array of PtAddressForwarding objects
     //!param: (in) size - The number of elements in the <i>forwards</i> array
     //!param: (out) nItems - The number of items assigned
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_MORE_DATA - There are more than <i>size</i> forwards
     //!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

   virtual PtStatus getMessageWaiting(PtBoolean& rFlag);
     //:Returns the current setting for the <i>message waiting</i> indicator.
     //!param: (out) rFlag - TRUE ==> on, FALSE ==> off
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

   PtStatus getName(char* rpName, int len);
     //:Returns the name associated with this PtAddress.
     //!param: (out) rpName - The reference used to return the name
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

   virtual PtStatus getOfferedTimeout(int& rMilliSecs);
     //:Sets <i>rMilliSecs</i> to the timeout value on this PtAddress for
     //:transitioning from the PtConnection::OFFERED state to the
     //:PtConnection::ALERTING state for an incoming call to this address.
     // See the description of PtAddress.setOfferedTimeout() for further
     // information on the offered timeout mechanism.
     //!param: (out) rMilliSecs - Set to the offered timeout value
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

   virtual PtStatus getProvider(PtProvider& rpProvider);
     //:Returns a pointer to the PtProvider associated with this PtAddress.
     //!param: (out) rpProvider - a pointer to the PtProvider object associated with this address
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

   virtual PtStatus getTerminals(PtTerminal terms[], int size, int& nItems);
     //:Returns an array of pointers to PtTerminal objects currently
     //:associated with this address.
     // The caller provides an array that can hold up to <i>size</i>
     // PtTerminal pointers.  This method will fill in the <i>terms</i> array
     // with up to <i>size</i> pointers.  The actual number of pointers
     // filled in is passed back via the <i>nItems</i> argument.
     //!param: (out) terms - The array of PtTerminal pointers
     //!param: (in) size - The number of elements in the <i>terms</i> array
     //!param: (out) nItems - The number of items assigned
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_MORE_DATA - There are more than <i>size</i> terminals
     //!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

   virtual PtStatus numAddressListeners(int& count);
     //:Returns the number of address listeners associated with this address.
     //!param: (out) count - The number of address listeners associated with this address
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

   virtual PtStatus numCallListeners(int& count);
     //:Returns the number of call listeners associated with this address.
     //!param: (out) count - The number of call listeners associated with this address
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

   virtual PtStatus numConnections(int& count);
     //:Returns the number of connections associated with this address.
     //!param: (out) count - The number of connections associated with this address
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

   virtual PtStatus numForwards(int& count);
     //:Returns the number of forwarding instructions associated with this
     //:address.
     //!param: (out) count - The number of forwarding instructions associated with this address
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

   virtual PtStatus numTerminals(int& count);
     //:Returns the number of terminals associated with this address.
     //!param: (out) count - The number of terminals associated with this address
     //!retcode: PT_SUCCESS - Success
     //!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

/* ============================ INQUIRY =================================== */

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
    static OsBSem           semInit ;
      //: Binary Semaphore used to guard initialiation and tear down
        static TaoReference             *mpTransactionCnt;
        static unsigned int     mRef;

        TaoClientTask   *mpClient;
        UtlString                       mAddress;

        OsTime          mTimeOut;

        void initialize();

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
        OsProtectEventMgr *mpEventMgr;

        TaoReference            *mpAddressListenerCnt;
        TaoObjectMap            *mpAddressListenerDb;

    static OsBSem                                mAddressForwardDbSem;
        static PtAddressForwarding      *mpAddressForwards;
        static int                                       mAddressForwardCnt;

        static PtBoolean        mbMessageWaiting;
        static PtBoolean        mbDoNotDisturb;
        static PtBoolean        mOfferedTimeout;

};

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

#endif  // _PtAddress_h_