Skip to content

Commit d248bc0

Browse files
authored
impl(v3): decommission PublisherOptions and SubscriberOptions (#15891)
1 parent 69724ae commit d248bc0

34 files changed

Lines changed: 126 additions & 1255 deletions
-5.65 KB
Binary file not shown.

doc/v3-migration-guide.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,117 @@ internal legacy files.
292292

293293
### Pubsub
294294

295+
<details>
296+
<summary>Removed <code>pubsub::PublisherOptions</code>
297+
</summary>
298+
#### `pubsub::PublisherOptions`
299+
300+
The deprecated `pubsub::PublisherOptions` has been removed. Please use
301+
`google::cloud::Options` instead.
302+
303+
The following table shows the mapping from `pubsub::PublisherOptions` methods to
304+
their `google::cloud::Options` equivalents:
305+
306+
| `pubsub::PublisherOptions` method | `google::cloud::Options` equivalent |
307+
| --------------------------------- | -------------------------------------------------- |
308+
| `(constructor)` | `google::cloud::Options{}` |
309+
| `set_maximum_hold_time` | `google::cloud::pubsub::MaxHoldTimeOption` |
310+
| `set_maximum_batch_message_count` | `google::cloud::pubsub::MaxBatchMessagesOption` |
311+
| `set_maximum_batch_bytes` | `google::cloud::pubsub::MaxBatchBytesOption` |
312+
| `enable_message_ordering` | `google::cloud::pubsub::MessageOrderingOption` |
313+
| `disable_message_ordering` | `google::cloud::pubsub::MessageOrderingOption` |
314+
| `set_maximum_pending_bytes` | `google::cloud::pubsub::MaxPendingBytesOption` |
315+
| `set_maximum_pending_messages` | `google::cloud::pubsub::MaxPendingMessagesOption` |
316+
| `set_full_publisher_ignored` | `google::cloud::pubsub::FullPublisherActionOption` |
317+
| `set_full_publisher_rejects` | `google::cloud::pubsub::FullPublisherActionOption` |
318+
| `set_full_publisher_blocks` | `google::cloud::pubsub::FullPublisherActionOption` |
319+
320+
Example usage of the replacements can be found below.
321+
322+
**Before:**
323+
324+
```cpp
325+
namespace gc = ::google::cloud;
326+
namespace pubsub = ::google::cloud::pubsub;
327+
328+
auto publisher_options = pubsub::PublisherOptions{}
329+
.enable_message_ordering()
330+
.set_full_publisher_ignored();
331+
332+
auto publisher = pubsub::Publisher(pubsub::MakePublisherConnection(
333+
topic, publisher_options);
334+
```
335+
336+
**After:**
337+
338+
```cpp
339+
namespace gc = ::google::cloud;
340+
namespace pubsub = ::google::cloud::pubsub;
341+
342+
auto options = gc::Options{}
343+
.set<pubsub::MessageOrderingOption>(true)
344+
.set<pubsub::FullPublisherActionOption>(
345+
pubsub::FullPublisherAction::kIgnored);
346+
347+
auto publisher = pubsub::Publisher(pubsub::MakePublisherConnection(
348+
topic, options));
349+
```
350+
351+
</details>
352+
353+
<details>
354+
<summary>Removed <code>pubsub::SubscriberOptions</code>
355+
</summary>
356+
#### `pubsub::SubscriberOptions`
357+
358+
The deprecated `pubsub::SubscriberOptions` has been removed. Please use
359+
`google::cloud::Options` instead.
360+
361+
The following table shows the mapping from `pubsub::SubscriberOptions` methods
362+
to their `google::cloud::Options` equivalents:
363+
364+
| `pubsub::SubscriberOptions` method | `google::cloud::Options` equivalent |
365+
| ---------------------------------- | ----------------------------------------------------- |
366+
| `(constructor)` | `google::cloud::Options{}` |
367+
| `set_max_deadline_time` | `google::cloud::pubsub::MaxDeadlineTimeOption` |
368+
| `set_max_deadline_extension` | `google::cloud::pubsub::MaxDeadlineExtensionOption` |
369+
| `set_max_outstanding_messages` | `google::cloud::pubsub::MaxOutstandingMessagesOption` |
370+
| `set_max_outstanding_bytes` | `google::cloud::pubsub::MaxOutstandingBytesOption` |
371+
| `set_max_concurrency` | `google::cloud::pubsub::MaxConcurrencyOption` |
372+
| `set_shutdown_polling_period` | `google::cloud::pubsub::ShutdownPollingPeriodOption` |
373+
374+
Example usage of the replacements can be found below.
375+
376+
**Before:**
377+
378+
```cpp
379+
namespace gc = ::google::cloud;
380+
namespace pubsub = ::google::cloud::pubsub;
381+
382+
auto subscriber_options = pubsub::SubscriberOptions{}
383+
.set_max_deadline_time(std::chrono::seconds(10))
384+
.set_max_outstanding_messages(42);
385+
386+
auto subscriber = pubsub::Subscriber(pubsub::MakeSubscriberConnection(
387+
subscription, subscriber_options);
388+
```
389+
390+
**After:**
391+
392+
```cpp
393+
namespace gc = ::google::cloud;
394+
namespace pubsub = ::google::cloud::pubsub;
395+
396+
auto options = gc::Options{}
397+
.set<pubsub::MaxDeadlineTimeOption>(std::chrono::seconds(10))
398+
.set<pubsub::MaxOutstandingMessagesOption>(42);
399+
400+
auto subscriber = pubsub::Subscriber(pubsub::MakeSubscriberConnection(
401+
subscription, options));
402+
```
403+
404+
</details>
405+
295406
### Spanner
296407

297408
<details>

google/cloud/pubsub/CMakeLists.txt

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -243,8 +243,6 @@ add_library(
243243
publisher.h
244244
publisher_connection.cc
245245
publisher_connection.h
246-
publisher_options.cc
247-
publisher_options.h
248246
pull_ack_handler.cc
249247
pull_ack_handler.h
250248
pull_response.h
@@ -266,8 +264,6 @@ add_library(
266264
subscriber.h
267265
subscriber_connection.cc
268266
subscriber_connection.h
269-
subscriber_options.cc
270-
subscriber_options.h
271267
subscription.cc
272268
subscription.h
273269
subscription_admin_client.cc
@@ -494,14 +490,12 @@ function (google_cloud_cpp_pubsub_client_define_tests)
494490
message_test.cc
495491
options_test.cc
496492
publisher_connection_test.cc
497-
publisher_options_test.cc
498493
publisher_test.cc
499494
pull_ack_handler_test.cc
500495
schema_test.cc
501496
snapshot_builder_test.cc
502497
snapshot_test.cc
503498
subscriber_connection_test.cc
504-
subscriber_options_test.cc
505499
subscriber_test.cc
506500
subscription_admin_client_test.cc
507501
subscription_admin_connection_test.cc

google/cloud/pubsub/benchmarks/throughput.cc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515
#include "google/cloud/pubsub/admin/subscription_admin_client.h"
1616
#include "google/cloud/pubsub/admin/topic_admin_client.h"
17+
#include "google/cloud/pubsub/options.h"
1718
#include "google/cloud/pubsub/publisher.h"
1819
#include "google/cloud/pubsub/subscriber.h"
1920
#include "google/cloud/pubsub/testing/random_names.h"

google/cloud/pubsub/blocking_publisher.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_PUBSUB_BLOCKING_PUBLISHER_H
1717

1818
#include "google/cloud/pubsub/blocking_publisher_connection.h"
19-
#include "google/cloud/pubsub/publisher_options.h"
2019
#include "google/cloud/pubsub/version.h"
2120
#include <string>
2221

google/cloud/pubsub/blocking_publisher_connection.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
#include "google/cloud/pubsub/connection_options.h"
2020
#include "google/cloud/pubsub/internal/publisher_stub.h"
2121
#include "google/cloud/pubsub/message.h"
22-
#include "google/cloud/pubsub/publisher_options.h"
2322
#include "google/cloud/pubsub/retry_policy.h"
2423
#include "google/cloud/pubsub/topic.h"
2524
#include "google/cloud/pubsub/version.h"

google/cloud/pubsub/google_cloud_cpp_pubsub.bzl

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,6 @@ google_cloud_cpp_pubsub_hdrs = [
129129
"options.h",
130130
"publisher.h",
131131
"publisher_connection.h",
132-
"publisher_options.h",
133132
"pull_ack_handler.h",
134133
"pull_response.h",
135134
"retry_policy.h",
@@ -142,7 +141,6 @@ google_cloud_cpp_pubsub_hdrs = [
142141
"snapshot_builder.h",
143142
"subscriber.h",
144143
"subscriber_connection.h",
145-
"subscriber_options.h",
146144
"subscription.h",
147145
"subscription_admin_client.h",
148146
"subscription_admin_connection.h",
@@ -248,7 +246,6 @@ google_cloud_cpp_pubsub_srcs = [
248246
"message.cc",
249247
"options.cc",
250248
"publisher_connection.cc",
251-
"publisher_options.cc",
252249
"pull_ack_handler.cc",
253250
"schema.cc",
254251
"schema_client.cc",
@@ -258,7 +255,6 @@ google_cloud_cpp_pubsub_srcs = [
258255
"snapshot_builder.cc",
259256
"subscriber.cc",
260257
"subscriber_connection.cc",
261-
"subscriber_options.cc",
262258
"subscription.cc",
263259
"subscription_admin_client.cc",
264260
"subscription_admin_connection.cc",

google/cloud/pubsub/integration_tests/subscriber_integration_test.cc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
#include "google/cloud/pubsub/internal/noop_message_callback.h"
2222
#include "google/cloud/pubsub/internal/streaming_subscription_batch_source.h"
2323
#include "google/cloud/pubsub/internal/subscriber_stub_factory.h"
24+
#include "google/cloud/pubsub/options.h"
2425
#include "google/cloud/pubsub/publisher.h"
2526
#include "google/cloud/pubsub/subscriber.h"
2627
#include "google/cloud/pubsub/subscription.h"

google/cloud/pubsub/internal/batching_publisher_connection.cc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// limitations under the License.
1414

1515
#include "google/cloud/pubsub/internal/batching_publisher_connection.h"
16+
#include "google/cloud/pubsub/options.h"
1617
#include "google/cloud/internal/make_status.h"
1718

1819
namespace google {

google/cloud/pubsub/internal/batching_publisher_connection_test.cc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515
#include "google/cloud/pubsub/internal/batching_publisher_connection.h"
1616
#include "google/cloud/pubsub/internal/defaults.h"
17+
#include "google/cloud/pubsub/options.h"
1718
#include "google/cloud/pubsub/testing/mock_batch_sink.h"
1819
#include "google/cloud/future.h"
1920
#include "google/cloud/internal/random.h"

0 commit comments

Comments
 (0)