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

#include <sharecontrolfile.hxx>

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

Public Member Functions

 ShareControlFile (std::u16string_view aOrigURL)
 
virtual ~ShareControlFile () override
 
std::vector< LockFileEntryGetUsersData ()
 
void SetUsersDataAndStore (std::unique_lock< std::mutex > &rGuard, std::vector< LockFileEntry > &&aUserNames)
 
LockFileEntry InsertOwnEntry ()
 
bool HasOwnEntry ()
 
void RemoveEntry (const LockFileEntry &aOptionalSpecification)
 
void RemoveEntry ()
 
void RemoveFile ()
 
- Public Member Functions inherited from svt::LockFileCommon
 LockFileCommon (OUString aLockFileURL)
 
virtual ~LockFileCommon ()
 
const OUString & GetURL () const
 
void SetURL (const OUString &aURL)
 

Private Member Functions

void Close ()
 
bool IsValid () const
 
void RemoveFileImpl (std::unique_lock< std::mutex > &rGuard)
 
std::vector< LockFileEntryGetUsersDataImpl (std::unique_lock< std::mutex > &rGuard)
 

Private Attributes

css::uno::Reference< css::io::XStream > m_xStream
 
css::uno::Reference< css::io::XInputStream > m_xInputStream
 
css::uno::Reference< css::io::XOutputStream > m_xOutputStream
 
css::uno::Reference< css::io::XSeekable > m_xSeekable
 
css::uno::Reference< css::io::XTruncate > m_xTruncate
 
std::vector< LockFileEntrym_aUsersData
 

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

Definition at line 36 of file sharecontrolfile.hxx.

Constructor & Destructor Documentation

◆ ShareControlFile()

svt::ShareControlFile::ShareControlFile ( std::u16string_view  aOrigURL)

◆ ~ShareControlFile()

svt::ShareControlFile::~ShareControlFile ( )
overridevirtual

Definition at line 104 of file sharecontrolfile.cxx.

References Close().

Member Function Documentation

◆ Close()

void svt::ShareControlFile::Close ( )
private

◆ GetUsersData()

std::vector< o3tl::enumarray< LockFileComponent, OUString > > svt::ShareControlFile::GetUsersData ( )

Definition at line 140 of file sharecontrolfile.cxx.

References GetUsersDataImpl(), and svt::LockFileCommon::m_aMutex.

◆ GetUsersDataImpl()

std::vector< o3tl::enumarray< LockFileComponent, OUString > > svt::ShareControlFile::GetUsersDataImpl ( std::unique_lock< std::mutex > &  rGuard)
private

◆ HasOwnEntry()

bool svt::ShareControlFile::HasOwnEntry ( )

◆ InsertOwnEntry()

LockFileEntry svt::ShareControlFile::InsertOwnEntry ( )

◆ IsValid()

bool svt::ShareControlFile::IsValid ( ) const
inlineprivate

◆ RemoveEntry() [1/2]

void svt::ShareControlFile::RemoveEntry ( )

Definition at line 281 of file sharecontrolfile.cxx.

References svt::LockFileCommon::GenerateOwnEntry(), and RemoveEntry().

Referenced by RemoveEntry().

◆ RemoveEntry() [2/2]

void svt::ShareControlFile::RemoveEntry ( const LockFileEntry aOptionalSpecification)

◆ RemoveFile()

void svt::ShareControlFile::RemoveFile ( )

Definition at line 318 of file sharecontrolfile.cxx.

References svt::LockFileCommon::m_aMutex, and RemoveFileImpl().

◆ RemoveFileImpl()

void svt::ShareControlFile::RemoveFileImpl ( std::unique_lock< std::mutex > &  rGuard)
private

◆ SetUsersDataAndStore()

void svt::ShareControlFile::SetUsersDataAndStore ( std::unique_lock< std::mutex > &  rGuard,
std::vector< LockFileEntry > &&  aUserNames 
)

Member Data Documentation

◆ m_aUsersData

std::vector< LockFileEntry > svt::ShareControlFile::m_aUsersData
private

◆ m_xInputStream

css::uno::Reference< css::io::XInputStream > svt::ShareControlFile::m_xInputStream
private

Definition at line 39 of file sharecontrolfile.hxx.

Referenced by Close(), GetUsersDataImpl(), and ShareControlFile().

◆ m_xOutputStream

css::uno::Reference< css::io::XOutputStream > svt::ShareControlFile::m_xOutputStream
private

Definition at line 40 of file sharecontrolfile.hxx.

Referenced by Close(), SetUsersDataAndStore(), and ShareControlFile().

◆ m_xSeekable

css::uno::Reference< css::io::XSeekable > svt::ShareControlFile::m_xSeekable
private

◆ m_xStream

css::uno::Reference< css::io::XStream > svt::ShareControlFile::m_xStream
private

Definition at line 38 of file sharecontrolfile.hxx.

Referenced by Close(), and ShareControlFile().

◆ m_xTruncate

css::uno::Reference< css::io::XTruncate > svt::ShareControlFile::m_xTruncate
private

Definition at line 42 of file sharecontrolfile.hxx.

Referenced by Close(), SetUsersDataAndStore(), and ShareControlFile().


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