LibreOffice Module svl (master) 1
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
svt::DocumentLockFile Class Referencefinal

Class implementing reading and writing LO lockfiles. More...

#include <documentlockfile.hxx>

Inheritance diagram for svt::DocumentLockFile:
[legend]
Collaboration diagram for svt::DocumentLockFile:
[legend]

Public Member Functions

 DocumentLockFile (std::u16string_view aOrigURL)
 
virtual ~DocumentLockFile () override
 
- Public Member Functions inherited from svt::GenDocumentLockFile
 GenDocumentLockFile (const OUString &aLockFileURL)
 
virtual ~GenDocumentLockFile () override
 
bool CreateOwnLockFile ()
 
bool OverwriteOwnLockFile ()
 
virtual void RemoveFile ()
 Delete the Lockfile, if current user is the owner. More...
 
void RemoveFileDirectly ()
 Only delete lockfile, disregarding ownership. More...
 
LockFileEntry GetLockData ()
 
- Public Member Functions inherited from svt::LockFileCommon
 LockFileCommon (OUString aLockFileURL)
 
virtual ~LockFileCommon ()
 
const OUString & GetURL () const
 
void SetURL (const OUString &aURL)
 

Protected Member Functions

virtual LockFileEntry GetLockDataImpl (std::unique_lock< std::mutex > &rGuard) override
 
- Protected Member Functions inherited from svt::GenDocumentLockFile
virtual LockFileEntry GetLockDataImpl (std::unique_lock< std::mutex > &rGuard)=0
 
virtual void WriteEntryToStream (std::unique_lock< std::mutex > &rGuard, const LockFileEntry &aEntry, const css::uno::Reference< css::io::XOutputStream > &xStream)=0
 
virtual css::uno::Reference< css::io::XInputStream > OpenStream (std::unique_lock< std::mutex > &rGuard)
 

Private Member Functions

virtual void WriteEntryToStream (std::unique_lock< std::mutex > &rGuard, const LockFileEntry &aEntry, const css::uno::Reference< css::io::XOutputStream > &xStream) override
 

Additional Inherited Members

- Static Public Member Functions inherited from svt::LockFileCommon
static void ParseList (const css::uno::Sequence< sal_Int8 > &aBuffer, std::vector< LockFileEntry > &rOutput)
 
static LockFileEntry ParseEntry (const css::uno::Sequence< sal_Int8 > &aBuffer, sal_Int32 &o_nCurPos)
 
static OUString ParseName (const css::uno::Sequence< sal_Int8 > &aBuffer, sal_Int32 &o_nCurPos)
 
static OUString EscapeCharacters (const OUString &aSource)
 
static OUString GetOOOUserName ()
 
static OUString GetCurrentLocalTime ()
 
static LockFileEntry GenerateOwnEntry ()
 
static INetURLObject ResolveLinks (const INetURLObject &aDocURL)
 
- Static Protected Member Functions inherited from svt::LockFileCommon
static OUString GenerateOwnLockFileURL (std::u16string_view aOrigURL, std::u16string_view aPrefix)
 This method generates the URL of the lock file based on the document URL and the specified prefix. More...
 
- Protected Attributes inherited from svt::LockFileCommon
std::mutex m_aMutex
 

Detailed Description

Class implementing reading and writing LO lockfiles.

Definition at line 55 of file documentlockfile.hxx.

Constructor & Destructor Documentation

◆ DocumentLockFile()

svt::DocumentLockFile::DocumentLockFile ( std::u16string_view  aOrigURL)

Definition at line 171 of file documentlockfile.cxx.

References u.

◆ ~DocumentLockFile()

svt::DocumentLockFile::~DocumentLockFile ( )
overridevirtual

Definition at line 177 of file documentlockfile.cxx.

Member Function Documentation

◆ GetLockDataImpl()

LockFileEntry svt::DocumentLockFile::GetLockDataImpl ( std::unique_lock< std::mutex > &  rGuard)
overrideprotectedvirtual

◆ WriteEntryToStream()

void svt::DocumentLockFile::WriteEntryToStream ( std::unique_lock< std::mutex > &  rGuard,
const LockFileEntry aEntry,
const css::uno::Reference< css::io::XOutputStream > &  xStream 
)
overrideprivatevirtual

The documentation for this class was generated from the following files: