Ubuntu TV Media Scanner
A centralized index for removable media content.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | List of all members
mediascanner::RefreshPolicy Class Referenceabstract

A refresh policy decides when changes to the media index must be re-read. More...

#include <mediascanner/refreshpolicy.h>

+ Inheritance diagram for mediascanner::RefreshPolicy:

Public Member Functions

virtual ~RefreshPolicy ()
 
virtual bool OnBeginReading (MediaIndex *index)=0
 This method is called by the MediaIndex before it starts any read operation. More...
 
virtual bool OnBeginWriting (WritableMediaIndex *index)=0
 This method is called by the WritableMediaIndex before it starts any write operation. More...
 

Static Public Member Functions

static RefreshPolicyPtr default_policy ()
 The default policy - currently an instance of InstantRefreshPolicy. More...
 

Detailed Description

A refresh policy decides when changes to the media index must be re-read.

A policy is needed because, to optimize performance, Lucene++ doesn't automatically refresh its index readers upon changes.

Constructor & Destructor Documentation

virtual mediascanner::RefreshPolicy::~RefreshPolicy ( )
virtual

Member Function Documentation

static RefreshPolicyPtr mediascanner::RefreshPolicy::default_policy ( )
static

The default policy - currently an instance of InstantRefreshPolicy.

virtual bool mediascanner::RefreshPolicy::OnBeginReading ( MediaIndex index)
pure virtual

This method is called by the MediaIndex before it starts any read operation.

The policy can now check if the media index needs to be reopened, can can do so if needed.

Parameters
index

Implemented in mediascanner::InstantRefreshPolicy.

virtual bool mediascanner::RefreshPolicy::OnBeginWriting ( WritableMediaIndex index)
pure virtual

This method is called by the WritableMediaIndex before it starts any write operation.

The policy can now check if the media index needs to be reopened, can can do so if needed.

Parameters
index

Implemented in mediascanner::InstantRefreshPolicy.