Added a note about only working with the given data

This commit is contained in:
Klaus Schmidinger 2017-06-23 09:08:40 +02:00
parent 56117751a8
commit ede2e89670
2 changed files with 12 additions and 8 deletions

10
skins.h
View File

@ -4,7 +4,7 @@
* See the main source file 'vdr.c' for copyright information and
* how to reach the author.
*
* $Id: skins.h 4.2 2017/06/21 09:40:39 kls Exp $
* $Id: skins.h 4.3 2017/06/23 09:08:40 kls Exp $
*/
#ifndef __SKINS_H
@ -23,9 +23,11 @@
// Several member functions of the following classes are called with a pointer to
// an object from a global list (cTimer, cChannel, cRecording or cEvent). In these
// cases the core VDR code holds a lock on the respective list. The called function
// may itself set a read lock (not a write lock!) on this list, because read locks
// can be nested. It may also set read locks (not write locks!) on higher order lists.
// cases the core VDR code holds a lock on the respective list. While in general a
// plugin should only work with the objects and data that is explicitly given to it
// in the function call, the called function may itself set a read lock (not a write
// lock!) on this list, because read locks can be nested. It may also set read locks
// (not write locks!) on higher order lists.
// For instance, a function that is called with a cChannel may lock cRecordings and/or
// cSchedules (which contains cEvent objects), but not cTimers. If a plugin needs to
// set locks of its own (on mutexes defined inside the plugin code), it shall do so

View File

@ -4,7 +4,7 @@
* See the main source file 'vdr.c' for copyright information and
* how to reach the author.
*
* $Id: status.h 4.2 2017/06/21 09:40:20 kls Exp $
* $Id: status.h 4.3 2017/06/23 09:08:24 kls Exp $
*/
#ifndef __STATUS_H
@ -17,9 +17,11 @@
// Several member functions of the following classes are called with a pointer to
// an object from a global list (cTimer, cChannel, cRecording or cEvent). In these
// cases the core VDR code holds a lock on the respective list. The called function
// may itself set a read lock (not a write lock!) on this list, because read locks
// can be nested. It may also set read locks (not write locks!) on higher order lists.
// cases the core VDR code holds a lock on the respective list. While in general a
// plugin should only work with the objects and data that is explicitly given to it
// in the function call, the called function may itself set a read lock (not a write
// lock!) on this list, because read locks can be nested. It may also set read locks
// (not write locks!) on higher order lists.
// For instance, a function that is called with a cChannel may lock cRecordings and/or
// cSchedules (which contains cEvent objects), but not cTimers. If a plugin needs to
// set locks of its own (on mutexes defined inside the plugin code), it shall do so