NCBI C++ ToolKit
Public Member Functions | List of all members
NDirectNetStorageImpl::CRWNotFound Class Reference

Search Toolkit Book for NDirectNetStorageImpl::CRWNotFound

#include "state.hpp"
(Private to src/misc/netstorage.)

+ Inheritance diagram for NDirectNetStorageImpl::CRWNotFound:
+ Collaboration diagram for NDirectNetStorageImpl::CRWNotFound:

Public Member Functions

ERW_Result Read (void *buf, size_t count, size_t *read) override
 Read as many as "count" bytes into a buffer pointed to by the "buf" argument. More...
 
ERW_Result PendingCount (size_t *count) override
 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...
 
bool Eof () override
 
ERW_Result Write (const void *buf, size_t count, size_t *written) override
 Write up to "count" bytes from the buffer pointed to by the "buf" argument onto the output device. More...
 
ERW_Result Flush () override
 Flush pending data (if any) down to the output device. More...
 
void Close () override
 
void Abort () override
 
- Public Member Functions inherited from SNetStorageObjectIoState
Uint8 GetSize () final
 
list< stringGetAttributeList () const final
 
string GetAttribute (const string &name) const final
 
void SetAttribute (const string &name, const string &value) final
 
CNetStorageObjectInfo GetInfo () final
 
void SetExpiration (const CTimeout &ttl) final
 
string FileTrack_Path () final
 
string Relocate (TNetStorageFlags flags, TNetStorageProgressCb cb) final
 
bool Exists () final
 
ENetStorageRemoveResult Remove () final
 
- Public Member Functions inherited from INetStorageObjectState
virtual string GetLoc () const =0
 
virtual pair< string, stringGetUserInfo ()
 
virtual CNetStorageObjectLocLocator ()
 
virtual void CancelRelocate ()
 
- Public Member Functions inherited from IReader
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 IWriter
virtual ~IWriter ()
 

Additional Inherited Members

- Protected Member Functions inherited from INetStorageObjectState
void EnterState (INetStorageObjectState *state)
 
void ExitState ()
 

Detailed Description

Definition at line 147 of file state.hpp.

Member Function Documentation

◆ Abort()

void NDirectNetStorageImpl::CRWNotFound::Abort ( void  )
inlineoverridevirtual

Implements IEmbeddedStreamWriter.

Definition at line 157 of file state.hpp.

References INetStorageObjectState::ExitState().

◆ Close()

void NDirectNetStorageImpl::CRWNotFound::Close ( void  )
inlineoverridevirtual

Implements IEmbeddedStreamWriter.

Definition at line 156 of file state.hpp.

References INetStorageObjectState::ExitState().

◆ Eof()

bool NDirectNetStorageImpl::CRWNotFound::Eof ( void  )
overridevirtual

Implements INetStorageObjectState.

Definition at line 61 of file state.cpp.

References INetStorageObjectState::GetLoc(), and NCBI_THROW_FMT.

◆ Flush()

ERW_Result NDirectNetStorageImpl::CRWNotFound::Flush ( )
inlineoverridevirtual

Flush pending data (if any) down to the output device.

Implements IWriter.

Definition at line 154 of file state.hpp.

References eRW_Success.

◆ PendingCount()

ERW_Result NDirectNetStorageImpl::CRWNotFound::PendingCount ( size_t *  count)
overridevirtual

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.

Return eRW_Success if the number of pending bytes has been stored at the location pointed to by "count". Return eRW_NotImplemented if the number cannot be determined. Otherwise, return other eRW_... condition to reflect the problem ("*count" does not need to be updated in the case of non-eRW_Success). Note that if reporting 0 bytes ready, the method may return either both eRW_Success and zero "*count", or return eRW_NotImplemented alone.

Implements IReader.

Definition at line 54 of file state.cpp.

References eRW_Error, INetStorageObjectState::GetLoc(), and NCBI_THROW_FMT.

◆ Read()

ERW_Result NDirectNetStorageImpl::CRWNotFound::Read ( void *  buf,
size_t  count,
size_t *  bytes_read 
)
overridevirtual

Read as many as "count" bytes into a buffer pointed to by the "buf" argument.

Always store the number of bytes actually read (0 if read none) via the pointer "bytes_read", if provided non-NULL. Return non-eRW_Success code if EOF / error condition has been encountered during the operation (some data may have been read, nevertheless, and reflected in "*bytes_read"). Special case: if "count" is passed as 0, then the value of "buf" must be ignored, and no change should be made to the state of the input device (but may return non-eRW_Success to indicate that the input device has already been in an error condition).

Note
Apparently, may not return eRW_Success if hasn't been able to read "count" bytes as requested, and "bytes_read" was provided as NULL.
When returning "*bytes_read" as zero for a non-zero "count" requested, the return status should not indicate eRW_Success.
Warning
"*bytes_read" may never be returned greater than "count".
Attention
It is implementation-dependent whether the call blocks until the entire buffer is read or the call returns when at least some data are available. In general, it is advised that this call is made within a loop that checks for EOF condition and proceeds with the reading until the required amount of data has been retrieved.

Implements IReader.

Definition at line 47 of file state.cpp.

References eRW_Error, INetStorageObjectState::GetLoc(), and NCBI_THROW_FMT.

◆ Write()

ERW_Result NDirectNetStorageImpl::CRWNotFound::Write ( const void *  buf,
size_t  count,
size_t *  bytes_written 
)
overridevirtual

Write up to "count" bytes from the buffer pointed to by the "buf" argument onto the output device.

Always store the number of bytes actually written, or 0 if "count" has been passed as 0 ("buf" must be ignored in this case), via the "bytes_written" pointer, if provided non-NULL. Note that the method can return non-eRW_Success in case of an I/O error along with indicating (some) data delivered to the output device (and reflected in "*bytes_written").

Note
Apparently, may not return eRW_Success if hasn't been able to write "count" bytes as requested, and "bytes_written" was passed as NULL.
When returning "*bytes_written" as zero for a non-zero "count" requested, the return status should not indicate eRW_Success.
Warning
"*bytes_written" may never be returned greater than "count".
Attention
It is implementation-dependent whether the call blocks until the entire buffer or only some data has been written out. In general, it is advised that this call is made within a loop that checks for errors and proceeds with the writing until the required amount of data has been sent.

Implements IWriter.

Definition at line 68 of file state.cpp.

References eRW_Error, INetStorageObjectState::GetLoc(), and NCBI_THROW_FMT.


The documentation for this class was generated from the following files:
Modified on Sun Feb 25 03:03:14 2024 by modify_doxy.py rev. 669887