Module presence_package

Description
Data Types
Function Index
Function Details

A very basic RFC3856 (SIP Presence) implementation.

Introduced in: 27 Apr 2006 by Fredrik Thulin <ft@it.su.se>

Behaviours: event_package.

Authors: Fredrik Thulin (ft@it.su.se).

Description

A very basic RFC3856 (SIP Presence) implementation.

PUBLISH is described in RFC3903 (SIP Event State Publication).

Data Types

event_pkg()

event_pkg() = string()

Event package string - "dialog" for this package.

Function Index

is_allowed_subscribe/7	YXA event packages must export an is_allowed_subscribe/6 function.
notify_content/4	YXA event packages must export a notify_content/3 function.
package_parameters/2	The minimum amount of time that should pass between NOTIFYs we send about this event packages events.
request/4	YXA event packages must export a request/6 function.
subscription_behaviour/3	When we receive a SUBSCRIBE, should the subscription handler also SUBSCRIBE to the other side in the same dialog? For the presence package, this depends on if the SUBSCRIBE has an Allow-Events header listing "presence".

is_allowed_subscribe(PkgS::event_pkg(), Num, Request, YxaCtx, SIPuser, Presentity, PkgState) -> {error, need_auth} | {ok, SubState, Status, Reason, ExtraHeaders, NewPkgState} | {siperror, Status, Reason, ExtraHeaders}

Num = integer()
Request = #request{}
YxaCtx = #yxa_ctx{}
SIPuser = undefined | string()
Presentity = undefined | {user, User} | {address, Address}
PkgState = undefined | #my_state{}
SubState = active | pending
Status = integer()
Reason = string()
ExtraHeaders = [{Key, ValueList}]
Body = binary() | list()
PkgState = #my_state{}

YXA event packages must export an is_allowed_subscribe/6 function. This function is called when the event server receives a subscription request for this event package, and is the event packages chance to decide wether the subscription should be accepted or not. It is also called for every time the subscription is refreshed by the subscriber.

notify_content/4

notify_content(PkgS::event_pkg(), Presentity, LastAccept, PkgState) -> {ok, Body, ExtraHeaders, NewPkgState} | {error, Reason}

Presentity = {users, UserList} | {address, AddressStr}
UserList = [string()]
AddressStr = string()
LastAccept = [string()]
PkgState = #my_state{}
Body = io_list()
ExtraHeaders = [{Key, ValueList}]
Reason = string() | atom()
NewPkgState = #my_state{}

YXA event packages must export a notify_content/3 function. Whenever the subscription requires us to generate a NOTIFY request, this function is called to generate the body and extra headers to include in the NOTIFY request.

package_parameters/2

package_parameters(PkgS::event_pkg(), Param::notification_rate_limit) -> MilliSeconds

MilliSeconds = integer()

The minimum amount of time that should pass between NOTIFYs we send about this event packages events.

request/4

request(PkgS::event_pkg(), Request, YxaCtx, Event_ctx::Ctx) -> void()

Request = #request{}
YxaCtx = #yxa_ctx{}
LogTag = string()
THandler = term()
Ctx = #event_ctx{}

returns: but return 'ok' or {error, Reason} for now

YXA event packages must export a request/6 function. See the eventserver.erl module description for more information about when this function is invoked.

subscription_behaviour/3

subscription_behaviour(PkgS::event_pkg(), Param::bidirectional_subscribe, Request) -> true | false

Request = #request{}

When we receive a SUBSCRIBE, should the subscription handler also SUBSCRIBE to the other side in the same dialog? For the presence package, this depends on if the SUBSCRIBE has an Allow-Events header listing "presence".

Generated by EDoc, Oct 17 2007, 16:48:12.