RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/structSNetStorageObjectRPC.html below:

NCBI C++ ToolKit: SNetStorageObjectRPC Struct Reference

Search Toolkit Book for SNetStorageObjectRPC

SNetStorageObjectRPC (SNetStorageObjectImpl &fsm, SNetStorageRPC *netstorage_rpc, CNetService service, TBuilder builder, const string &object_loc) ERW_Result Read (void *buf, size_t count, size_t *bytes_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...
ERW_Result Write (const void *buf, size_t count, size_t *bytes_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 string GetLoc () const override bool Eof () override Uint8 GetSize () override list< string > GetAttributeList () const override string GetAttribute (const string &attr_name) const override void SetAttribute (const string &attr_name, const string &attr_value) override CNetStorageObjectInfo GetInfo () override void SetExpiration (const CTimeout &) override string FileTrack_Path () override string Relocate (TNetStorageFlags flags, TNetStorageProgressCb cb) override bool Exists () override ENetStorageRemoveResult Remove () override void StartWriting (CJsonNode::TInstance request, CNetServerConnection::TInstance conn) virtual pair< string, string > GetUserInfo () virtual CNetStorageObjectLoc & Locator () virtual void CancelRelocate () 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 () virtual ~IWriter ()

Definition at line 506 of file netstorage_rpc.cpp.

◆ TBuilder ◆ SNetStorageObjectRPC() ◆ Abort() void SNetStorageObjectRPC::Abort ( void ) overridevirtual ◆ Close() void SNetStorageObjectRPC::Close ( void ) overridevirtual ◆ Eof() bool SNetStorageObjectRPC::Eof ( void ) overridevirtual ◆ Exchange() CJsonNode SNetStorageObjectRPC::Exchange ( ) const inlineprivate

Definition at line 611 of file netstorage_rpc.cpp.

References SNetStorageObjectRPC::SContext::m_Connection, m_Context, m_NetStorageRPC, SNetStorageObjectRPC::SContext::m_OriginalRequest, and m_OwnService.

Referenced by Exists(), FileTrack_Path(), GetAttribute(), GetAttributeList(), GetInfo(), GetSize(), Remove(), SetAttribute(), SetExpiration(), and Write().

◆ Exists() bool SNetStorageObjectRPC::Exists ( void ) overridevirtual ◆ FileTrack_Path() string SNetStorageObjectRPC::FileTrack_Path ( ) overridevirtual ◆ Flush() ◆ GetAttribute() ◆ GetAttributeList() list< string > SNetStorageObjectRPC::GetAttributeList ( ) const overridevirtual ◆ GetInfo() ◆ GetLoc() string SNetStorageObjectRPC::GetLoc ( void ) const inlineoverridevirtual ◆ GetSize() Uint8 SNetStorageObjectRPC::GetSize ( void ) overridevirtual ◆ MkRequest() void SNetStorageObjectRPC::MkRequest ( const string & request_type ) const inlineprivate

Definition at line 616 of file netstorage_rpc.cpp.

References SNetStorageObjectRPC::SContext::locator, m_Builder, m_Context, and SNetStorageObjectRPC::SContext::m_OriginalRequest.

Referenced by Exists(), FileTrack_Path(), GetAttribute(), GetAttributeList(), GetInfo(), GetSize(), Read(), Relocate(), Remove(), SetAttribute(), SetExpiration(), and Write().

◆ PendingCount() ERW_Result SNetStorageObjectRPC::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 1291 of file netstorage_rpc.cpp.

References count, and eRW_Success.

◆ Read() ERW_Result SNetStorageObjectRPC::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 1056 of file netstorage_rpc.cpp.

References buffer, INetStorageObjectState::EnterState(), CNetService::eRandomize, CJsonOverUTTPExecHandler::GetConnection(), CNetService::Iterate(), SNetStorageObjectRPC::SContext::m_Connection, m_Context, m_IState, SNetStorageObjectRPC::SContext::m_OriginalRequest, m_OwnService, MkRequest(), and SNetServerImpl::TryExec().

◆ Relocate()

Implements INetStorageObjectState.

Definition at line 842 of file netstorage_rpc.cpp.

References CJsonNode::AsString(), CNetService::eRandomize, flags, CJsonNode::GetByKeyOrNull(), CJsonOverUTTPExecHandler::GetConnection(), CNetService::Iterate(), SNetStorageObjectRPC::SContext::m_Connection, m_Context, SNetStorageObjectRPC::SContext::m_OriginalRequest, m_OwnService, MkRequest(), NCBI_THROW_FMT, CJsonNode::NewObjectNode(), SNetStorageObjectRPC::SContext::ReadMessage(), CJsonNode::Repr(), s_SetStorageFlags(), CJsonNode::SetBoolean(), CJsonNode::SetByKey(), and SNetServerImpl::TryExec().

◆ Remove() ◆ SetAttribute() ◆ SetExpiration() void SNetStorageObjectRPC::SetExpiration ( const CTimeout & ttl ) overridevirtual ◆ StartWriting() ◆ Write() ERW_Result SNetStorageObjectRPC::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 1155 of file netstorage_rpc.cpp.

References INetStorageObjectState::EnterState(), Exchange(), CJsonNode::GetString(), SNetStorageObjectRPC::SContext::locator, m_Context, m_OState, and MkRequest().

◆ m_Builder TBuilder SNetStorageObjectRPC::m_Builder private ◆ m_Context SContext SNetStorageObjectRPC::m_Context private

Definition at line 624 of file netstorage_rpc.cpp.

Referenced by SNetStorageObjectRPC::SIState::Abort(), SNetStorageObjectRPC::SOState::Abort(), SNetStorageObjectRPC::SIState::Close(), SNetStorageObjectRPC::SOState::Close(), Exchange(), GetAttribute(), GetLoc(), MkRequest(), Read(), SNetStorageObjectRPC::SIState::Read(), Relocate(), SetAttribute(), SetExpiration(), SNetStorageObjectRPC::SIState::StartReading(), StartWriting(), Write(), and SNetStorageObjectRPC::SOState::Write().

◆ m_IState ◆ m_NetStorageRPC ◆ m_OState ◆ m_OwnService

The documentation for this struct was generated from the following file:

src/connect/services/netstorage_rpc.cpp

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4