howto_prototypes.h

/* $Id$
 
 (c) Copyright, Real-Time Innovations, 2003-2016. 
 All rights reserved.
 No duplications, whole or partial, manual or electronic, may be made
 without express written permission.  Any such copies, or
 revisions thereof, must display this notice unaltered.
 This code contains trade secrets of Real-Time Innovations, Inc.
 
 PUPROSE:
   Participant use cases
 
modification history
--------------------
1.0h,24jul06,kaj replace long with DDS_Long
1.0d,02jun04,rw  Bug #8050: changed prototype of DataWriter::write()
1.0d,19apr04,eys Read/take parameters changed
1.0a,27oct03,gpc Written by combining pre-existing headers
===================================================================== */
 
class FooDataWriter;
class Foo;
 
extern DDSDomainParticipantFactory* howto_get_factory();
 
extern DDSDomainParticipant* 
                howto_setup_participant(DDSDomainParticipantFactory* factory,
                                  DDS_DomainId_t domain_id);
 
extern void howto_teardown_participant(DDSDomainParticipantFactory* factory,
                                 DDSDomainParticipant* participant);
 
extern void howto_register_type(DDSDomainParticipant* participant, 
                          const char* type_name);
 
extern DDSTopic* howto_setup_topic(DDSDomainParticipant* participant,
                               const char* topic_name, const char* type_name);
 
extern void howto_teardown_topic(DDSDomainParticipant* participant, 
                           DDSTopic* topic);
 
extern DDSDataWriter* howto_setup_writer(DDSPublisher* publisher,
                                     DDSTopic* topic);
 
extern void howto_send_data(FooDataWriter* writer, Foo& data,
                      DDS_InstanceHandle_t instance_handle);
 
extern void howto_teardown_writer(DDSPublisher* publisher, 
                            DDSDataWriter* writer);
 
extern DDSDataReader* howto_setup_reader(DDSSubscriber* subscriber,
                                     DDSTopic* topic);
 
extern void howto_teardown_reader(DDSSubscriber* subscriber, 
                            DDSDataReader* reader);
 
extern void howto_setup_reader_to_access_received_data_via_listener(
    DDSDataReader* entity, DDSDataReaderListener* entity_listener);
 
extern void howto_access_received_data_via_reader(
    DDSDataReader* datareader,
    DDS_Long max_samples,
    DDS_SampleStateMask sample_state_mask,
    DDS_ViewStateMask view_state_mask,
    DDS_InstanceStateMask instance_state_mask);
 
extern DDSSubscriber* howto_setup_subscriber(DDSDomainParticipant* participant);
 
extern void howto_teardown_subscriber(DDSDomainParticipant* participant, 
                               DDSSubscriber* subscriber);
 
extern void howto_setup_subscriber_to_access_received_data_via_listener(
    DDSSubscriber* entity,  DDSSubscriberListener* entity_listener);
 
extern void howto_access_received_data_via_subscriber(DDSSubscriber* subscriber);
 
extern DDSPublisher* howto_setup_publisher(DDSDomainParticipant* participant);
 
extern void howto_teardown_publisher(DDSDomainParticipant* participant, 
                               DDSPublisher* publisher);