NCBI C++ ToolKit
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
INetStorageObjectState Struct Referenceabstract

Search Toolkit Book for INetStorageObjectState

#include <connect/services/impl/netstorage_impl.hpp>

+ Inheritance diagram for INetStorageObjectState:
+ Collaboration diagram for INetStorageObjectState:

Public Member Functions

virtual string GetLoc () const =0
 
virtual bool Eof ()=0
 
virtual Uint8 GetSize ()=0
 
virtual list< stringGetAttributeList () const =0
 
virtual string GetAttribute (const string &name) const =0
 
virtual void SetAttribute (const string &name, const string &value)=0
 
virtual CNetStorageObjectInfo GetInfo ()=0
 
virtual void SetExpiration (const CTimeout &ttl)=0
 
virtual string FileTrack_Path ()=0
 
virtual string Relocate (TNetStorageFlags flags, TNetStorageProgressCb cb)=0
 
virtual bool Exists ()=0
 
virtual ENetStorageRemoveResult Remove ()=0
 
virtual pair< string, stringGetUserInfo ()
 
virtual CNetStorageObjectLocLocator ()
 
virtual void CancelRelocate ()
 
- Public Member Functions inherited from IReader
virtual ERW_Result Read (void *buf, size_t count, size_t *bytes_read=0)=0
 Read as many as "count" bytes into a buffer pointed to by the "buf" argument. More...
 
virtual ERW_Result PendingCount (size_t *count)=0
 Via parameter "count" (which is guaranteed to be supplied non-NULL) return the number of bytes that are ready to be read from the input device without blocking. More...
 
virtual ERW_Result Pushback (const void *buf, size_t count, void *del_ptr=0)
 This method gets called by RStream buffer destructor to return buffered yet still unread (from the stream) portion of data back to the device. More...
 
virtual ~IReader ()
 
- Public Member Functions inherited from IEmbeddedStreamWriter
virtual void Close ()=0
 
virtual void Abort ()=0
 
- Public Member Functions inherited from IWriter
virtual ERW_Result Write (const void *buf, size_t count, size_t *bytes_written=0)=0
 Write up to "count" bytes from the buffer pointed to by the "buf" argument onto the output device. More...
 
virtual ERW_Result Flush (void)=0
 Flush pending data (if any) down to the output device. More...
 
virtual ~IWriter ()
 

Protected Member Functions

void EnterState (INetStorageObjectState *state)
 
void ExitState ()
 

Private Member Functions

virtual SNetStorageObjectImplFsm ()=0
 

Detailed Description

Definition at line 47 of file netstorage_impl.hpp.

Member Function Documentation

◆ CancelRelocate()

virtual void INetStorageObjectState::CancelRelocate ( )
inlinevirtual

Reimplemented in NDirectNetStorageImpl::CROState, and NDirectNetStorageImpl::CObj.

Definition at line 72 of file netstorage_impl.hpp.

References NCBI_THROW_FMT.

◆ EnterState()

void INetStorageObjectState::EnterState ( INetStorageObjectState state)
inlineprotected

◆ Eof()

virtual bool INetStorageObjectState::Eof ( )
pure virtual

◆ Exists()

virtual bool INetStorageObjectState::Exists ( )
pure virtual

◆ ExitState()

void INetStorageObjectState::ExitState ( )
inlineprotected

◆ FileTrack_Path()

virtual string INetStorageObjectState::FileTrack_Path ( )
pure virtual

◆ Fsm()

virtual SNetStorageObjectImpl& INetStorageObjectState::Fsm ( )
privatepure virtual

◆ GetAttribute()

virtual string INetStorageObjectState::GetAttribute ( const string name) const
pure virtual

◆ GetAttributeList()

virtual list<string> INetStorageObjectState::GetAttributeList ( ) const
pure virtual

◆ GetInfo()

virtual CNetStorageObjectInfo INetStorageObjectState::GetInfo ( )
pure virtual

◆ GetLoc()

virtual string INetStorageObjectState::GetLoc ( ) const
pure virtual

◆ GetSize()

virtual Uint8 INetStorageObjectState::GetSize ( )
pure virtual

◆ GetUserInfo()

virtual pair<string, string> INetStorageObjectState::GetUserInfo ( )
inlinevirtual

Reimplemented in NDirectNetStorageImpl::CObj.

Definition at line 62 of file netstorage_impl.hpp.

References NCBI_THROW_FMT.

◆ Locator()

virtual CNetStorageObjectLoc& INetStorageObjectState::Locator ( )
inlinevirtual

Reimplemented in NDirectNetStorageImpl::CObj.

Definition at line 67 of file netstorage_impl.hpp.

References NCBI_THROW_FMT.

◆ Relocate()

virtual string INetStorageObjectState::Relocate ( TNetStorageFlags  flags,
TNetStorageProgressCb  cb 
)
pure virtual

◆ Remove()

virtual ENetStorageRemoveResult INetStorageObjectState::Remove ( )
pure virtual

◆ SetAttribute()

virtual void INetStorageObjectState::SetAttribute ( const string name,
const string value 
)
pure virtual

◆ SetExpiration()

virtual void INetStorageObjectState::SetExpiration ( const CTimeout ttl)
pure virtual

The documentation for this struct was generated from the following file:
Modified on Sat Mar 02 10:56:05 2024 by modify_doxy.py rev. 669887