RTI Connext C API Version 7.7.0
howto_prototypes.h
1/* $Id$
2
3 (c) Copyright, Real-Time Innovations, 2004-2016.
4 All rights reserved.
5 No duplications, whole or partial, manual or electronic, may be made
6 without express written permission. Any such copies, or
7 revisions thereof, must display this notice unaltered.
8 This code contains trade secrets of Real-Time Innovations, Inc.
9
10 PUPROSE:
11 Participant use cases
12
13modification history
14--------------------
151.0d,19apr04,eys Read/take parameters changed
161.0a,27oct03,gpc Written by combining pre-existing headers
17===================================================================== */
18
19#include "Foo.h"
20#include "FooSupport.h"
21
22
23extern DDS_DomainParticipantFactory* howto_get_factory(void);
24
26 howto_setup_participant(DDS_DomainParticipantFactory* factory,
27 DDS_DomainId_t domain_id);
28
29extern void howto_teardown_participant(DDS_DomainParticipantFactory* factory,
30 DDS_DomainParticipant* participant);
31
32extern void howto_register_type(DDS_DomainParticipant* participant,
33 const char* type_name);
34
35extern DDS_Topic* howto_setup_topic(DDS_DomainParticipant* participant,
36 const char* topic_name, const char* type_name);
37
38extern void howto_teardown_topic(DDS_DomainParticipant* participant,
39 DDS_Topic* topic);
40
41extern DDS_DataWriter* howto_setup_writer(DDS_Publisher* publisher,
42 DDS_Topic* topic);
43
44
45extern void howto_send_data(FooDataWriter* writer, Foo* data,
46 DDS_InstanceHandle_t instance_handle);
47
48extern void howto_teardown_writer(DDS_Publisher* publisher,
49 DDS_DataWriter* writer);
50
51extern DDS_DataReader* howto_setup_reader(DDS_Subscriber* subscriber,
52 DDS_Topic* topic);
53
54extern void howto_teardown_reader(DDS_Subscriber* subscriber,
55 DDS_DataReader* reader);
56
57extern void howto_setup_reader_to_access_received_data_via_listener(
58 DDS_DataReader* entity, struct DDS_DataReaderListener* entity_listener);
59
60extern void howto_access_received_data_via_reader(
61 DDS_DataReader* datareader,
62 DDS_Long max_samples,
63 DDS_SampleStateMask sample_state_mask,
64 DDS_ViewStateMask view_state_mask,
65 DDS_InstanceStateMask instance_state_mask);
66
67extern DDS_Subscriber* howto_setup_subscriber(DDS_DomainParticipant* participant);
68
69extern void howto_teardown_subscriber(DDS_DomainParticipant* participant,
70 DDS_Subscriber* subscriber);
71
72extern void howto_setup_subscriber_to_access_received_data_via_listener(
73 DDS_Subscriber* entity, struct DDS_SubscriberListener* entity_listener);
74
75extern void howto_access_received_data_via_subscriber(DDS_Subscriber* subscriber);
76
77extern DDS_Publisher* howto_setup_publisher(DDS_DomainParticipant* participant);
78
79extern void howto_teardown_publisher(DDS_DomainParticipant* participant,
80 DDS_Publisher* publisher);
RTICdrLong DDS_Long
Defines a long integer data type, equivalent to IDL/CDR long.
Definition: common.ifc:244
struct DDS_DomainParticipantFactoryImpl DDS_DomainParticipantFactory
<<singleton>> <<interface>> Allows creation and destruction of DDS_DomainParticipant objects.
Definition: domain.ifc:2870
DDS_DOMAINID_TYPE_NATIVE DDS_DomainId_t
An integer that indicates in which domain a DDS_DomainParticipant communicates.
Definition: domain.ifc:240
struct DDS_DomainParticipantImpl DDS_DomainParticipant
<<interface>> Container for all DDS_DomainEntity objects.
Definition: infrastructure.ifc:9931
DDS_UnsignedLong DDS_InstanceStateMask
A bit-mask (list) of instance states, i.e. DDS_InstanceStateKind.
Definition: subscription.ifc:1128
struct DDS_PublisherImpl DDS_Publisher
<<interface>> A publisher is the object responsible for the actual dissemination of publications.
Definition: publication.ifc:182
struct DDS_DataReaderImpl DDS_DataReader
<<interface>> Allows the application to: (1) declare the data it wishes to receive (i....
Definition: subscription.ifc:225
DDS_UnsignedLong DDS_SampleStateMask
A bit-mask (list) of sample states, i.e. DDS_SampleStateKind.
Definition: subscription.ifc:1055
struct DDS_SubscriberImpl DDS_Subscriber
<<interface>> A subscriber is the object responsible for actually receiving data from a subscription.
Definition: subscription.ifc:234
struct DDS_TopicWrapperI DDS_Topic
<<interface>> The most basic description of the data to be published and subscribed.
Definition: topic.ifc:521
DDS_HANDLE_TYPE_NATIVE DDS_InstanceHandle_t
Type definition for an instance handle.
Definition: infrastructure.ifc:900
DDS_UnsignedLong DDS_ViewStateMask
A bit-mask (list) of view states, i.e. DDS_ViewStateKind.
Definition: subscription.ifc:1090
struct DDS_DataWriterImpl DDS_DataWriter
<<interface>> Allows an application to set the value of the data to be published under a given DDS_To...
Definition: publication.ifc:174
<<interface>> DDS_Listener for reader status.
Definition: subscription.ifc:2190
<<interface>> DDS_Listener for status about a subscriber.
Definition: subscription.ifc:2333
<<interface>> <<generic>> User data type specific data writer.
Definition: data.ifc:466
A representative user-defined data type.
Definition: data.ifc:112