OPAL  Version 3.14.3
im.h File Reference
#include <ptlib.h>
#include <opal_config.h>
#include <ptclib/url.h>
#include <opal//transports.h>
Include dependency graph for im.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

class  OpalIM
 
class  OpalIMContext
 
struct  OpalIMContext::ConversationInfo
 
struct  OpalIMContext::DispositionInfo
 
struct  OpalIMContext::CompositionInfo
 

Macros

#define OPAL_SIPIM   "SIP-IM"
 
#define OpalSIPIM   GetOpalSIPIM()
 
#define OPAL_T140   "T.140"
 
#define OpalT140   GetOpalT140()
 
#define OPAL_MSRP   "MSRP"
 
#define OpalMSRP   GetOpalMSRP()
 
#define OPAL_IM_MEDIA_TYPE_PREFIX   "im-"
 
Message transmit
#define PDECLARE_MessageDispositionNotifier(cls, fn)   PDECLARE_NOTIFIER2(OpalIMContext, cls, fn, OpalIMContext::DispositionInfo)
 Macro to declare correctly typed disposition notifier. More...
 
#define PDECLARE_ASYNC_MessageDispositionNotifier(cls, fn)   PDECLARE_NOTIFIER2(OpalIMContext, cls, fn, OpalIMContext::DispositionInfo)
 Macro to declare correctly typed asynchronous disposition notifier. More...
 
#define PCREATE_MessageDispositionNotifier(fn)   PCREATE_NOTIFIER2(fn, OpalIMContext::DispositionInfo)
 Macro to create correctly typed disposition notifier. More...
 
Message receipt
#define PDECLARE_MessageReceivedNotifier(cls, fn)   PDECLARE_NOTIFIER2(OpalIMContext, cls, fn, OpalIM)
 Macro to declare correctly typed message received notifier. More...
 
#define PDECLARE_ASYNC_MessageReceivedNotifier(cls, fn)   PDECLARE_ASYNC_NOTIFIER2(OpalIMContext, cls, fn, OpalIM)
 Macro to declare correctly typed asynchronous message received notifier. More...
 
#define PCREATE_MessageReceivedNotifier(fn)   PCREATE_NOTIFIER2(fn, OpalIM)
 Macro to create correctly typed message received notifier. More...
 
Message composition
#define PDECLARE_CompositionIndicationNotifier(cls, fn)   PDECLARE_NOTIFIER2(OpalIMContext, cls, fn, OpalIMContext::CompositionInfo)
 Macro to declare correctly typed composition indication notifier. More...
 
#define PDECLARE_ASYNC_CompositionIndicationNotifier(cls, fn)   PDECLARE_ASYNC_NOTIFIER2(OpalIMContext, cls, fn, OpalIMContext::CompositionInfo)
 Macro to declare correctly typed asynchronous composition indication notifier. More...
 
#define PCREATE_CompositionIndicationNotifier(fn)   PCREATE_NOTIFIER2(fn, OpalIMContext::CompositionInfo)
 Macro to create correctly typed composition indication notifier. More...
 

Functions

const OpalMediaFormatGetOpalSIPIM ()
 
const OpalMediaFormatGetOpalT140 ()
 
const OpalMediaFormatGetOpalMSRP ()
 

Macro Definition Documentation

#define OPAL_IM_MEDIA_TYPE_PREFIX   "im-"
#define OPAL_MSRP   "MSRP"
#define OPAL_SIPIM   "SIP-IM"
#define OPAL_T140   "T.140"
#define OpalMSRP   GetOpalMSRP()
#define OpalSIPIM   GetOpalSIPIM()
#define OpalT140   GetOpalT140()
#define PCREATE_CompositionIndicationNotifier (   fn)    PCREATE_NOTIFIER2(fn, OpalIMContext::CompositionInfo)

Macro to create correctly typed composition indication notifier.

#define PCREATE_MessageDispositionNotifier (   fn)    PCREATE_NOTIFIER2(fn, OpalIMContext::DispositionInfo)

Macro to create correctly typed disposition notifier.

#define PCREATE_MessageReceivedNotifier (   fn)    PCREATE_NOTIFIER2(fn, OpalIM)

Macro to create correctly typed message received notifier.

#define PDECLARE_ASYNC_CompositionIndicationNotifier (   cls,
  fn 
)    PDECLARE_ASYNC_NOTIFIER2(OpalIMContext, cls, fn, OpalIMContext::CompositionInfo)

Macro to declare correctly typed asynchronous composition indication notifier.

#define PDECLARE_ASYNC_MessageDispositionNotifier (   cls,
  fn 
)    PDECLARE_NOTIFIER2(OpalIMContext, cls, fn, OpalIMContext::DispositionInfo)

Macro to declare correctly typed asynchronous disposition notifier.

#define PDECLARE_ASYNC_MessageReceivedNotifier (   cls,
  fn 
)    PDECLARE_ASYNC_NOTIFIER2(OpalIMContext, cls, fn, OpalIM)

Macro to declare correctly typed asynchronous message received notifier.

#define PDECLARE_CompositionIndicationNotifier (   cls,
  fn 
)    PDECLARE_NOTIFIER2(OpalIMContext, cls, fn, OpalIMContext::CompositionInfo)

Macro to declare correctly typed composition indication notifier.

#define PDECLARE_MessageDispositionNotifier (   cls,
  fn 
)    PDECLARE_NOTIFIER2(OpalIMContext, cls, fn, OpalIMContext::DispositionInfo)

Macro to declare correctly typed disposition notifier.

#define PDECLARE_MessageReceivedNotifier (   cls,
  fn 
)    PDECLARE_NOTIFIER2(OpalIMContext, cls, fn, OpalIM)

Macro to declare correctly typed message received notifier.

Function Documentation

const OpalMediaFormat& GetOpalMSRP ( )
const OpalMediaFormat& GetOpalSIPIM ( )
const OpalMediaFormat& GetOpalT140 ( )