CORBA 2.6.1 Programmer's Reference

See also Fw_Transfer_EH_User and NSDEFw_GFS.
API Methods
Fw_Message( void );
Constructor for an empty message. Note that the preferred method for obtaining an Fw_Message
is get_message;
~Fw_Message();
Destructor. Deletes any associated Fw_MDs. Note that the preferred method for disposing of an
Fw_Message is free_Message.
static void free_message( Fw_Message *pp_message );
Frees any associated Fw_MDs, saves the Fw_Message for subsequent reuse. This is the preferred
method for disposing of an Fw_Message.
static Fw_Message* get_message( void );
Returns a new or recycled Fw_Message. This is the preferred method for obtaining an
Fw_Message.
static long get_recycle_count( void );
Returns the number of Fw_Messages that are currently saved and available for reuse.
static void set_test_no_Messages( const bool pv_no_Messages );
Allows simulation of resource shortage for testing what happens if the ORB cant allocate a new
Message. When pv_no_Messages is true, the get_message method fails.
void add_last_MD( Fw_MD *pp_MD );
Adds a message data descriptor to the end of the list of Fw_MDs in the Fw_Message . This
capability is useful when accumulating data segments that are part of one logical message.
bool is_empty( void );
Helper method that returns true if the Fw_Message has zero Fw_MDs associated with it.
unsigned long get_iv_size( void );
Returns the number of data bytes available for reading in the Fw_Message. This number is the
accumulation of the iv_data_bytes from all the Fw_MDs associated with the Fw_Message.
The original value is zero.
unsigned long get_iv_bytes_read( void );
Returns the number of bytes that have been consumed from the Fw_Message. The original value
is zero.
void begin_read( void );
Prepares an Fw_Message for consumption by the read and skip_read methods. Note that
begin_read must be called prior to the first call to read or skip_read.