Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for ON_REQUESTED_INCOMPATIBLE_QOS and ON_OFFERED_INCOMPATIBLE_QOS events #193

Merged
merged 11 commits into from
Mar 27, 2020
2 changes: 2 additions & 0 deletions rmw/include/rmw/event.h
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,12 @@ typedef enum rmw_event_type_t
// subscription events
RMW_EVENT_LIVELINESS_CHANGED,
RMW_EVENT_REQUESTED_DEADLINE_MISSED,
RMW_EVENT_REQUESTED_QOS_INCOMPATIBLE,

// publisher events
RMW_EVENT_LIVELINESS_LOST,
RMW_EVENT_OFFERED_DEADLINE_MISSED,
RMW_EVENT_OFFERED_QOS_INCOMPATIBLE,

// sentinel value
RMW_EVENT_INVALID
Expand Down
68 changes: 68 additions & 0 deletions rmw/include/rmw/incompatible_qos_events_statuses.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
// Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef RMW__INCOMPATIBLE_QOS_EVENTS_STATUSES_H_
#define RMW__INCOMPATIBLE_QOS_EVENTS_STATUSES_H_

#include <stdint.h>

#include "rmw/visibility_control.h"

#ifdef __cplusplus
extern "C"
{
#endif

/// QoS Policy Kinds
typedef enum RMW_PUBLIC_TYPE rmw_qos_policy_kind_t
{
RMW_QOS_POLICY_INVALID = 1 << 0,
RMW_QOS_POLICY_DURABILITY = 1 << 1,
RMW_QOS_POLICY_DEADLINE = 1 << 2,
RMW_QOS_POLICY_LIVELINESS = 1 << 3,
RMW_QOS_POLICY_RELIABILITY = 1 << 4,
RMW_QOS_POLICY_HISTORY = 1 << 5,
RMW_QOS_POLICY_LIFESPAN = 1 << 6
} rmw_qos_policy_kind_t;

struct RMW_PUBLIC_TYPE rmw_qos_incompatible_event_status_t
{
/**
* Total cumulative number of times the concerned subscription discovered a
* publisher for the same topic with an offered QoS that was incompatible
* with that requested by the subscription.
*/
int32_t total_count;
/**
* The change in total_count since the last time the status was read.
*/
int32_t total_count_change;
/**
* The Qos Policy Kind of one of the policies that was found to be
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since you've changed the enum to bitflags, is the intent to only return "one of the policies" or is it now intended to return a bitfield with "all of the policies" that were incompatible?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Defining it as a bitflags opens up the possibility of returning multiple policies. However, currently the rmw implementations are still only capable of returning one policy.

* incompatible the last time an incompatibility was detected.
*/
rmw_qos_policy_kind_t last_policy_kind;
};

/// Event state for a subscription's 'RMW_EVENT_REQUESTED_QOS_INCOMPATIBLE' events.
typedef struct rmw_qos_incompatible_event_status_t rmw_requested_qos_incompatible_event_status_t;

/// Event state for a publisher's 'RMW_EVENT_OFFERED_QOS_INCOMPATIBLE' events.
typedef struct rmw_qos_incompatible_event_status_t rmw_offered_qos_incompatible_event_status_t;

#ifdef __cplusplus
}
#endif

#endif // RMW__INCOMPATIBLE_QOS_EVENTS_STATUSES_H_