wornvirtue
/
premiere-libtorrent
forked from premiere/premiere-libtorrent
1
0
Fork 0
Code Pull Requests Activity

merged documentation fix from RC_0_16

This commit is contained in:
Arvid Norberg 2012-11-17 23:52:13 +00:00
parent f12e1c1a3f
commit 63a1af3c49
2 changed files with 1167 additions and 1091 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2241
docs/manual.html
View File

File diff suppressed because it is too large Load Diff

17
docs/manual.rst
View File

@ -224,6 +224,7 @@ The ``session`` class has the following synopsis::
void set_alert_mask(int m);
size_t set_alert_queue_size_limit(
size_t queue_size_limit_);
void set_alert_dispatch(boost::function<void(std::auto_ptr<alert>)> const& fun);
feed_handle session::add_feed(feed_settings const& feed);
void session::remove_feed(feed_handle h);
@ -1178,6 +1179,22 @@ To control the max number of alerts that's queued by the session, see
``save_resume_data_alert`` and ``save_resume_data_failed_alert`` are always posted, regardelss
of the alert mask.
set_alert_dispatch()
--------------------
::
void set_alert_dispatch(boost::function<void(std::auto_ptr<alert>)> const& fun);
This sets a function to be called (from within libtorrent's netowrk thread) every time an alert
is posted. Since the function (``fun``) is run in libtorrent's internal thread, it may not call
any of libtorrent's external API functions. Doing so results in a dead lock.
The main intention with this function is to support integration with platform-dependent message
queues or signalling systems. For instance, on windows, one could post a message to an HNWD or
on linux, write to a pipe or an eventfd.
add_feed()
----------