Goby3  3.1.4
2024.02.22
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
goby::acomms::protobuf::TransferResponse Class Reference

#include <goby/acomms/protobuf/file_transfer.pb.h>

Inheritance diagram for goby::acomms::protobuf::TransferResponse:
google::protobuf::Message google::protobuf::MessageLite

Public Types

enum  DCCLParameters { DCCL_ID = 9, DCCL_MAX_BYTES = 64 }
 
typedef TransferResponse_ErrorCode ErrorCode
 
- Public Types inherited from google::protobuf::Message
typedef google::protobuf::Reflection Reflection
 

Public Member Functions

 TransferResponse ()
 
virtual ~TransferResponse ()
 
 TransferResponse (const TransferResponse &from)
 
TransferResponse & operator= (const TransferResponse &from)
 
const ::google::protobuf::UnknownFieldSet & unknown_fields () const
 
inline ::google::protobuf::UnknownFieldSet * mutable_unknown_fields ()
 
void Swap (TransferResponse *other)
 
TransferResponse * New () const final
 
TransferResponse * New (::google::protobuf::Arena *arena) const final
 
void CopyFrom (const ::google::protobuf::Message &from) final
 
void MergeFrom (const ::google::protobuf::Message &from) final
 
void CopyFrom (const TransferResponse &from)
 
void MergeFrom (const TransferResponse &from)
 
void Clear () final
 
bool IsInitialized () const final
 
size_t ByteSizeLong () const final
 
bool MergePartialFromCodedStream (::google::protobuf::io::CodedInputStream *input) final
 
void SerializeWithCachedSizes (::google::protobuf::io::CodedOutputStream *output) const final
 
::google::protobuf::uint8 * InternalSerializeWithCachedSizesToArray (bool deterministic, ::google::protobuf::uint8 *target) const final
 
int GetCachedSize () const final
 
::google::protobuf::Metadata GetMetadata () const final
 
bool has_src () const
 
void clear_src ()
 
::google::protobuf::int32 src () const
 
void set_src (::google::protobuf::int32 value)
 
bool has_dest () const
 
void clear_dest ()
 
::google::protobuf::int32 dest () const
 
void set_dest (::google::protobuf::int32 value)
 
bool has_transfer_successful () const
 
void clear_transfer_successful ()
 
bool transfer_successful () const
 
void set_transfer_successful (bool value)
 
bool has_num_fragments () const
 
void clear_num_fragments ()
 
::google::protobuf::int32 num_fragments () const
 
void set_num_fragments (::google::protobuf::int32 value)
 
bool has_error () const
 
void clear_error ()
 
::goby::acomms::protobuf::TransferResponse_ErrorCode error () const
 
void set_error (::goby::acomms::protobuf::TransferResponse_ErrorCode value)
 
- Public Member Functions inherited from google::protobuf::Message
 Message ()
 
virtual ~Message ()
 
virtual void CopyFrom (const Message &from)
 
virtual void MergeFrom (const Message &from)
 
void CheckInitialized () const
 
void FindInitializationErrors (std::vector< string > *errors) const
 
string InitializationErrorString () const
 
virtual void DiscardUnknownFields ()
 
virtual size_t SpaceUsedLong () const
 
int SpaceUsed () const
 
string DebugString () const
 
string ShortDebugString () const
 
string Utf8DebugString () const
 
void PrintDebugString () const
 
bool ParseFromFileDescriptor (int file_descriptor)
 
bool ParsePartialFromFileDescriptor (int file_descriptor)
 
bool ParseFromIstream (std::istream *input)
 
bool ParsePartialFromIstream (std::istream *input)
 
bool SerializeToFileDescriptor (int file_descriptor) const
 
bool SerializePartialToFileDescriptor (int file_descriptor) const
 
bool SerializeToOstream (std::ostream *output) const
 
bool SerializePartialToOstream (std::ostream *output) const
 
virtual string GetTypeName () const
 
virtual void CheckTypeAndMergeFrom (const MessageLite &other)
 
virtual bool MergePartialFromCodedStream (io::CodedInputStream *input)
 
virtual void SerializeWithCachedSizes (io::CodedOutputStream *output) const
 
const Descriptor * GetDescriptor () const
 
virtual const Reflection * GetReflection () const final
 
- Public Member Functions inherited from google::protobuf::MessageLite
 MessageLite ()
 
virtual ~MessageLite ()
 
virtual ::google::protobuf::Arena * GetArena () const
 
virtual void * GetMaybeArenaPointer () const
 
bool ParseFromCodedStream (io::CodedInputStream *input)
 
bool ParsePartialFromCodedStream (io::CodedInputStream *input)
 
bool ParseFromZeroCopyStream (io::ZeroCopyInputStream *input)
 
bool ParsePartialFromZeroCopyStream (io::ZeroCopyInputStream *input)
 
bool ParseFromBoundedZeroCopyStream (io::ZeroCopyInputStream *input, int size)
 
bool ParsePartialFromBoundedZeroCopyStream (io::ZeroCopyInputStream *input, int size)
 
bool ParseFromString (const string &data)
 
bool ParsePartialFromString (const string &data)
 
bool ParseFromArray (const void *data, int size)
 
bool ParsePartialFromArray (const void *data, int size)
 
bool MergeFromCodedStream (io::CodedInputStream *input)
 
bool SerializeToCodedStream (io::CodedOutputStream *output) const
 
bool SerializePartialToCodedStream (io::CodedOutputStream *output) const
 
bool SerializeToZeroCopyStream (io::ZeroCopyOutputStream *output) const
 
bool SerializePartialToZeroCopyStream (io::ZeroCopyOutputStream *output) const
 
bool SerializeToString (string *output) const
 
bool SerializePartialToString (string *output) const
 
bool SerializeToArray (void *data, int size) const
 
bool SerializePartialToArray (void *data, int size) const
 
string SerializeAsString () const
 
string SerializePartialAsString () const
 
bool AppendToString (string *output) const
 
bool AppendPartialToString (string *output) const
 
int ByteSize () const
 
virtual uint8 * SerializeWithCachedSizesToArray (uint8 *target) const
 
virtual uint8 * InternalSerializeWithCachedSizesToArray (bool deterministic, uint8 *target) const
 

Static Public Member Functions

static const ::google::protobuf::Descriptor * descriptor ()
 
static const TransferResponse & default_instance ()
 
static void InitAsDefaultInstance ()
 
static const TransferResponse * internal_default_instance ()
 
static bool ErrorCode_IsValid (int value)
 
static const ::google::protobuf::EnumDescriptor * ErrorCode_descriptor ()
 
static const ::std::string & ErrorCode_Name (ErrorCode value)
 
static bool ErrorCode_Parse (const ::std::string &name, ErrorCode *value)
 

Static Public Attributes

static constexpr int kIndexInFileMessages
 
static const ErrorCode COULD_NOT_READ_FILE
 
static const ErrorCode FILE_TOO_LARGE
 
static const ErrorCode TIMEOUT
 
static const ErrorCode COULD_NOT_WRITE_FILE
 
static const ErrorCode ERROR_WHILE_READING
 
static const ErrorCode OTHER_ERROR
 
static const ErrorCode ErrorCode_MIN
 
static const ErrorCode ErrorCode_MAX
 
static const int ErrorCode_ARRAYSIZE
 
static const int kSrcFieldNumber = 1
 
static const int kDestFieldNumber = 2
 
static const int kTransferSuccessfulFieldNumber = 3
 
static const int kNumFragmentsFieldNumber = 5
 
static const int kErrorFieldNumber = 4
 

Friends

struct ::protobuf_goby_2facomms_2fprotobuf_2ffile_5ftransfer_2eproto::TableStruct
 
void swap (TransferResponse &a, TransferResponse &b)
 

Additional Inherited Members

- Static Protected Member Functions inherited from google::protobuf::MessageLite
template<typename T >
::google::protobuf::internal::RepeatedPtrFieldBase * CastToBase (::google::protobuf::RepeatedPtrField< T > *repeated)
 
template<typename T >
static const ::google::protobuf::internal::RepeatedPtrFieldBase & CastToBase (const ::google::protobuf::RepeatedPtrField< T > &repeated)
 
template<typename T >
static T * CreateMaybeMessage (Arena *arena)
 

Detailed Description

Definition at line 483 of file file_transfer.pb.h.

Member Typedef Documentation

◆ ErrorCode

typedef TransferResponse_ErrorCode goby::acomms::protobuf::TransferResponse::ErrorCode

Definition at line 575 of file file_transfer.pb.h.

Member Enumeration Documentation

◆ DCCLParameters

enum goby::acomms::protobuf::TransferResponse::DCCLParameters
Enumerator
DCCL_ID 
DCCL_MAX_BYTES 

Definition at line 646 of file file_transfer.pb.h.

Constructor & Destructor Documentation

◆ TransferResponse() [1/2]

goby::acomms::protobuf::TransferResponse::TransferResponse ( )

◆ ~TransferResponse()

virtual goby::acomms::protobuf::TransferResponse::~TransferResponse ( )
virtual

◆ TransferResponse() [2/2]

goby::acomms::protobuf::TransferResponse::TransferResponse ( const TransferResponse &  from)

Member Function Documentation

◆ ByteSizeLong()

size_t goby::acomms::protobuf::TransferResponse::ByteSizeLong ( ) const
finalvirtual

Reimplemented from google::protobuf::Message.

◆ Clear()

void goby::acomms::protobuf::TransferResponse::Clear ( )
finalvirtual

Reimplemented from google::protobuf::Message.

◆ clear_dest()

void goby::acomms::protobuf::TransferResponse::clear_dest ( )
inline

Definition at line 1051 of file file_transfer.pb.h.

◆ clear_error()

void goby::acomms::protobuf::TransferResponse::clear_error ( )
inline

Definition at line 1099 of file file_transfer.pb.h.

◆ clear_num_fragments()

void goby::acomms::protobuf::TransferResponse::clear_num_fragments ( )
inline

Definition at line 1124 of file file_transfer.pb.h.

◆ clear_src()

void goby::acomms::protobuf::TransferResponse::clear_src ( )
inline

Definition at line 1027 of file file_transfer.pb.h.

◆ clear_transfer_successful()

void goby::acomms::protobuf::TransferResponse::clear_transfer_successful ( )
inline

Definition at line 1075 of file file_transfer.pb.h.

◆ CopyFrom() [1/2]

void goby::acomms::protobuf::TransferResponse::CopyFrom ( const ::google::protobuf::Message &  from)
final

◆ CopyFrom() [2/2]

void goby::acomms::protobuf::TransferResponse::CopyFrom ( const TransferResponse &  from)

◆ default_instance()

static const TransferResponse& goby::acomms::protobuf::TransferResponse::default_instance ( )
static

◆ descriptor()

static const ::google::protobuf::Descriptor* goby::acomms::protobuf::TransferResponse::descriptor ( )
static

◆ dest()

google::protobuf::int32 goby::acomms::protobuf::TransferResponse::dest ( ) const
inline

Definition at line 1055 of file file_transfer.pb.h.

◆ error()

goby::acomms::protobuf::TransferResponse_ErrorCode goby::acomms::protobuf::TransferResponse::error ( ) const
inline

Definition at line 1103 of file file_transfer.pb.h.

◆ ErrorCode_descriptor()

static const ::google::protobuf::EnumDescriptor* goby::acomms::protobuf::TransferResponse::ErrorCode_descriptor ( )
inlinestatic

Definition at line 598 of file file_transfer.pb.h.

◆ ErrorCode_IsValid()

static bool goby::acomms::protobuf::TransferResponse::ErrorCode_IsValid ( int  value)
inlinestatic

Definition at line 588 of file file_transfer.pb.h.

◆ ErrorCode_Name()

static const ::std::string& goby::acomms::protobuf::TransferResponse::ErrorCode_Name ( ErrorCode  value)
inlinestatic

Definition at line 601 of file file_transfer.pb.h.

◆ ErrorCode_Parse()

static bool goby::acomms::protobuf::TransferResponse::ErrorCode_Parse ( const ::std::string &  name,
ErrorCode *  value 
)
inlinestatic

Definition at line 604 of file file_transfer.pb.h.

◆ GetCachedSize()

int goby::acomms::protobuf::TransferResponse::GetCachedSize ( ) const
inlinefinalvirtual

Implements google::protobuf::MessageLite.

Definition at line 555 of file file_transfer.pb.h.

◆ GetMetadata()

::google::protobuf::Metadata goby::acomms::protobuf::TransferResponse::GetMetadata ( ) const
finalvirtual

Implements google::protobuf::Message.

◆ has_dest()

bool goby::acomms::protobuf::TransferResponse::has_dest ( ) const
inline

Definition at line 1042 of file file_transfer.pb.h.

◆ has_error()

bool goby::acomms::protobuf::TransferResponse::has_error ( ) const
inline

Definition at line 1090 of file file_transfer.pb.h.

◆ has_num_fragments()

bool goby::acomms::protobuf::TransferResponse::has_num_fragments ( ) const
inline

Definition at line 1115 of file file_transfer.pb.h.

◆ has_src()

bool goby::acomms::protobuf::TransferResponse::has_src ( ) const
inline

Definition at line 1018 of file file_transfer.pb.h.

◆ has_transfer_successful()

bool goby::acomms::protobuf::TransferResponse::has_transfer_successful ( ) const
inline

Definition at line 1066 of file file_transfer.pb.h.

◆ InitAsDefaultInstance()

static void goby::acomms::protobuf::TransferResponse::InitAsDefaultInstance ( )
static

◆ internal_default_instance()

static const TransferResponse* goby::acomms::protobuf::TransferResponse::internal_default_instance ( )
inlinestatic

Definition at line 520 of file file_transfer.pb.h.

◆ InternalSerializeWithCachedSizesToArray()

::google::protobuf::uint8* goby::acomms::protobuf::TransferResponse::InternalSerializeWithCachedSizesToArray ( bool  deterministic,
::google::protobuf::uint8 *  target 
) const
final

◆ IsInitialized()

bool goby::acomms::protobuf::TransferResponse::IsInitialized ( ) const
finalvirtual

Reimplemented from google::protobuf::Message.

◆ MergeFrom() [1/2]

void goby::acomms::protobuf::TransferResponse::MergeFrom ( const ::google::protobuf::Message &  from)
final

◆ MergeFrom() [2/2]

void goby::acomms::protobuf::TransferResponse::MergeFrom ( const TransferResponse &  from)

◆ MergePartialFromCodedStream()

bool goby::acomms::protobuf::TransferResponse::MergePartialFromCodedStream ( ::google::protobuf::io::CodedInputStream *  input)
final

◆ mutable_unknown_fields()

inline ::google::protobuf::UnknownFieldSet* goby::acomms::protobuf::TransferResponse::mutable_unknown_fields ( )
inline

Definition at line 512 of file file_transfer.pb.h.

◆ New() [1/2]

TransferResponse* goby::acomms::protobuf::TransferResponse::New ( ) const
inlinefinalvirtual

Implements google::protobuf::Message.

Definition at line 534 of file file_transfer.pb.h.

◆ New() [2/2]

TransferResponse* goby::acomms::protobuf::TransferResponse::New ( ::google::protobuf::Arena *  arena) const
inlinefinalvirtual

Reimplemented from google::protobuf::Message.

Definition at line 538 of file file_transfer.pb.h.

◆ num_fragments()

google::protobuf::int32 goby::acomms::protobuf::TransferResponse::num_fragments ( ) const
inline

Definition at line 1128 of file file_transfer.pb.h.

◆ operator=()

TransferResponse& goby::acomms::protobuf::TransferResponse::operator= ( const TransferResponse &  from)
inline

Definition at line 490 of file file_transfer.pb.h.

◆ SerializeWithCachedSizes()

void goby::acomms::protobuf::TransferResponse::SerializeWithCachedSizes ( ::google::protobuf::io::CodedOutputStream *  output) const
final

◆ set_dest()

void goby::acomms::protobuf::TransferResponse::set_dest ( ::google::protobuf::int32  value)
inline

Definition at line 1059 of file file_transfer.pb.h.

◆ set_error()

void goby::acomms::protobuf::TransferResponse::set_error ( ::goby::acomms::protobuf::TransferResponse_ErrorCode  value)
inline

Definition at line 1107 of file file_transfer.pb.h.

◆ set_num_fragments()

void goby::acomms::protobuf::TransferResponse::set_num_fragments ( ::google::protobuf::int32  value)
inline

Definition at line 1132 of file file_transfer.pb.h.

◆ set_src()

void goby::acomms::protobuf::TransferResponse::set_src ( ::google::protobuf::int32  value)
inline

Definition at line 1035 of file file_transfer.pb.h.

◆ set_transfer_successful()

void goby::acomms::protobuf::TransferResponse::set_transfer_successful ( bool  value)
inline

Definition at line 1083 of file file_transfer.pb.h.

◆ src()

google::protobuf::int32 goby::acomms::protobuf::TransferResponse::src ( ) const
inline

Definition at line 1031 of file file_transfer.pb.h.

◆ Swap()

void goby::acomms::protobuf::TransferResponse::Swap ( TransferResponse *  other)

◆ transfer_successful()

bool goby::acomms::protobuf::TransferResponse::transfer_successful ( ) const
inline

Definition at line 1079 of file file_transfer.pb.h.

◆ unknown_fields()

const ::google::protobuf::UnknownFieldSet& goby::acomms::protobuf::TransferResponse::unknown_fields ( ) const
inline

Definition at line 509 of file file_transfer.pb.h.

Friends And Related Function Documentation

◆ ::protobuf_goby_2facomms_2fprotobuf_2ffile_5ftransfer_2eproto::TableStruct

friend struct ::protobuf_goby_2facomms_2fprotobuf_2ffile_5ftransfer_2eproto::TableStruct
friend

Definition at line 671 of file file_transfer.pb.h.

◆ swap

void swap ( TransferResponse &  a,
TransferResponse &  b 
)
friend

Definition at line 528 of file file_transfer.pb.h.

Member Data Documentation

◆ COULD_NOT_READ_FILE

const ErrorCode goby::acomms::protobuf::TransferResponse::COULD_NOT_READ_FILE
static
Initial value:
=
TransferResponse_ErrorCode_COULD_NOT_READ_FILE

Definition at line 576 of file file_transfer.pb.h.

◆ COULD_NOT_WRITE_FILE

const ErrorCode goby::acomms::protobuf::TransferResponse::COULD_NOT_WRITE_FILE
static
Initial value:
=
TransferResponse_ErrorCode_COULD_NOT_WRITE_FILE

Definition at line 582 of file file_transfer.pb.h.

◆ ERROR_WHILE_READING

const ErrorCode goby::acomms::protobuf::TransferResponse::ERROR_WHILE_READING
static
Initial value:
=
TransferResponse_ErrorCode_ERROR_WHILE_READING

Definition at line 584 of file file_transfer.pb.h.

◆ ErrorCode_ARRAYSIZE

const int goby::acomms::protobuf::TransferResponse::ErrorCode_ARRAYSIZE
static
Initial value:
=
TransferResponse_ErrorCode_ErrorCode_ARRAYSIZE

Definition at line 595 of file file_transfer.pb.h.

◆ ErrorCode_MAX

const ErrorCode goby::acomms::protobuf::TransferResponse::ErrorCode_MAX
static
Initial value:
=
TransferResponse_ErrorCode_ErrorCode_MAX

Definition at line 593 of file file_transfer.pb.h.

◆ ErrorCode_MIN

const ErrorCode goby::acomms::protobuf::TransferResponse::ErrorCode_MIN
static
Initial value:
=
TransferResponse_ErrorCode_ErrorCode_MIN

Definition at line 591 of file file_transfer.pb.h.

◆ FILE_TOO_LARGE

const ErrorCode goby::acomms::protobuf::TransferResponse::FILE_TOO_LARGE
static
Initial value:
=
TransferResponse_ErrorCode_FILE_TOO_LARGE

Definition at line 578 of file file_transfer.pb.h.

◆ kDestFieldNumber

const int goby::acomms::protobuf::TransferResponse::kDestFieldNumber = 2
static

Definition at line 621 of file file_transfer.pb.h.

◆ kErrorFieldNumber

const int goby::acomms::protobuf::TransferResponse::kErrorFieldNumber = 4
static

Definition at line 642 of file file_transfer.pb.h.

◆ kIndexInFileMessages

constexpr int goby::acomms::protobuf::TransferResponse::kIndexInFileMessages
staticconstexpr
Initial value:
=
2

Definition at line 524 of file file_transfer.pb.h.

◆ kNumFragmentsFieldNumber

const int goby::acomms::protobuf::TransferResponse::kNumFragmentsFieldNumber = 5
static

Definition at line 635 of file file_transfer.pb.h.

◆ kSrcFieldNumber

const int goby::acomms::protobuf::TransferResponse::kSrcFieldNumber = 1
static

Definition at line 614 of file file_transfer.pb.h.

◆ kTransferSuccessfulFieldNumber

const int goby::acomms::protobuf::TransferResponse::kTransferSuccessfulFieldNumber = 3
static

Definition at line 628 of file file_transfer.pb.h.

◆ OTHER_ERROR

const ErrorCode goby::acomms::protobuf::TransferResponse::OTHER_ERROR
static
Initial value:
=
TransferResponse_ErrorCode_OTHER_ERROR

Definition at line 586 of file file_transfer.pb.h.

◆ TIMEOUT

const ErrorCode goby::acomms::protobuf::TransferResponse::TIMEOUT
static
Initial value:
=
TransferResponse_ErrorCode_TIMEOUT

Definition at line 580 of file file_transfer.pb.h.

The documentation for this class was generated from the following file:
goby::acomms::protobuf::TransferResponse_ErrorCode_COULD_NOT_READ_FILE
@ TransferResponse_ErrorCode_COULD_NOT_READ_FILE
Definition: file_transfer.pb.h:101
goby::acomms::protobuf::TransferResponse_ErrorCode_COULD_NOT_WRITE_FILE
@ TransferResponse_ErrorCode_COULD_NOT_WRITE_FILE
Definition: file_transfer.pb.h:104
goby::acomms::protobuf::TransferResponse_ErrorCode_FILE_TOO_LARGE
@ TransferResponse_ErrorCode_FILE_TOO_LARGE
Definition: file_transfer.pb.h:102
goby::acomms::protobuf::TransferResponse_ErrorCode_ErrorCode_ARRAYSIZE
const int TransferResponse_ErrorCode_ErrorCode_ARRAYSIZE
Definition: file_transfer.pb.h:111
goby::acomms::protobuf::TransferResponse_ErrorCode_OTHER_ERROR
@ TransferResponse_ErrorCode_OTHER_ERROR
Definition: file_transfer.pb.h:106
goby::acomms::protobuf::TransferResponse_ErrorCode_ERROR_WHILE_READING
@ TransferResponse_ErrorCode_ERROR_WHILE_READING
Definition: file_transfer.pb.h:105
goby::acomms::protobuf::TransferResponse_ErrorCode_ErrorCode_MIN
const TransferResponse_ErrorCode TransferResponse_ErrorCode_ErrorCode_MIN
Definition: file_transfer.pb.h:109
goby::acomms::protobuf::TransferResponse_ErrorCode_TIMEOUT
@ TransferResponse_ErrorCode_TIMEOUT
Definition: file_transfer.pb.h:103
goby::acomms::protobuf::TransferResponse_ErrorCode_ErrorCode_MAX
const TransferResponse_ErrorCode TransferResponse_ErrorCode_ErrorCode_MAX
Definition: file_transfer.pb.h:110