Qpid Proton C++ API  0.33.0
container.hpp
Go to the documentation of this file.
1 #ifndef PROTON_CONTAINER_HPP
2 #define PROTON_CONTAINER_HPP
3 
4 /*
5  *
6  * Licensed to the Apache Software Foundation (ASF) under one
7  * or more contributor license agreements. See the NOTICE file
8  * distributed with this work for additional information
9  * regarding copyright ownership. The ASF licenses this file
10  * to you under the Apache License, Version 2.0 (the
11  * "License"); you may not use this file except in compliance
12  * with the License. You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing,
17  * software distributed under the License is distributed on an
18  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19  * KIND, either express or implied. See the License for the
20  * specific language governing permissions and limitations
21  * under the License.
22  *
23  */
24 
25 #include "./fwd.hpp"
26 #include "./returned.hpp"
27 #include "./types_fwd.hpp"
28 
29 #include "./internal/config.hpp"
30 #include "./internal/export.hpp"
31 #include "./internal/pn_unique_ptr.hpp"
32 
33 #include <string>
34 
37 
38 namespace proton {
39 
50 class PN_CPP_CLASS_EXTERN container {
51  public:
62  PN_CPP_EXTERN container(messaging_handler& handler, const std::string& id);
63 
72  PN_CPP_EXTERN container(messaging_handler& handler);
73 
76  PN_CPP_EXTERN container(const std::string& id);
77 
81  PN_CPP_EXTERN container();
82 
92  PN_CPP_EXTERN ~container();
93 
108  PN_CPP_EXTERN returned<connection> connect(const std::string& conn_url,
109  const connection_options& conn_opts);
110 
114  PN_CPP_EXTERN returned<connection> connect(const std::string& conn_url);
115 
119  PN_CPP_EXTERN returned<connection> connect();
120 
133  PN_CPP_EXTERN listener listen(const std::string& listen_url,
134  listen_handler& handler);
135 
144  PN_CPP_EXTERN listener listen(const std::string& listen_url,
145  const connection_options& conn_opts);
146 
152  PN_CPP_EXTERN listener listen(const std::string& listen_url);
153 
162  PN_CPP_EXTERN void run();
163 
164 #if PN_CPP_SUPPORTS_THREADS
165  PN_CPP_EXTERN void run(int count);
172 #endif
173 
180  PN_CPP_EXTERN void auto_stop(bool enabled);
181 
185  PN_CPP_EXTERN void stop(const error_condition& err);
186 
199  PN_CPP_EXTERN void stop();
200 
204  PN_CPP_EXTERN returned<sender> open_sender(const std::string& addr_url);
205 
212  PN_CPP_EXTERN returned<sender> open_sender(const std::string& addr_url,
213  const proton::sender_options& snd_opts);
214 
221  PN_CPP_EXTERN returned<sender> open_sender(const std::string& addr_url,
222  const connection_options& conn_opts);
223 
230  PN_CPP_EXTERN returned<sender> open_sender(const std::string& addr_url,
231  const proton::sender_options& snd_opts,
232  const connection_options& conn_opts);
233 
237  PN_CPP_EXTERN returned<receiver> open_receiver(const std::string& addr_url);
238 
239 
246  PN_CPP_EXTERN returned<receiver> open_receiver(const std::string& addr_url,
247  const proton::receiver_options& rcv_opts);
248 
255  PN_CPP_EXTERN returned<receiver> open_receiver(const std::string& addr_url,
256  const connection_options& conn_opts);
257 
264  PN_CPP_EXTERN returned<receiver> open_receiver(const std::string& addr_url,
265  const proton::receiver_options& rcv_opts,
266  const connection_options& conn_opts);
267 
269  PN_CPP_EXTERN std::string id() const;
270 
274  PN_CPP_EXTERN void client_connection_options(const connection_options& conn_opts);
275 
278 
283  PN_CPP_EXTERN void server_connection_options(const connection_options& conn_opts);
284 
287 
291  PN_CPP_EXTERN void sender_options(const class sender_options& snd_opts);
292 
294  PN_CPP_EXTERN class sender_options sender_options() const;
295 
299  PN_CPP_EXTERN void receiver_options(const class receiver_options& rcv_opts);
300 
302  PN_CPP_EXTERN class receiver_options receiver_options() const;
303 
309  PN_CPP_EXTERN void schedule(duration dur, work fn);
310 
312  PN_CPP_EXTERN PN_CPP_DEPRECATED("Use 'container::schedule(duration, work)'") void schedule(duration dur, void_function0& fn);
313 
314  private:
317 #if PN_CPP_HAS_LAMBDAS && PN_CPP_HAS_VARIADIC_TEMPLATES
318  PN_CPP_EXTERN void schedule(duration dur, internal::v03::work fn);
319 #endif
320  class impl;
321  internal::pn_unique_ptr<impl> impl_;
322 
324  friend class connection_options;
325  friend class session_options;
326  friend class receiver_options;
327  friend class sender_options;
328  friend class work_queue;
330 };
331 
332 } // proton
333 
334 #endif // PROTON_CONTAINER_HPP
proton::error_condition
Describes an endpoint error state.
Definition: error_condition.hpp:40
proton::container::container
container()
Create a container.
proton::container::schedule
void schedule(duration dur, work fn)
Schedule fn for execution after a duration.
proton::container::stop
void stop(const error_condition &err)
Stop the container with error condition err.
proton::container::~container
~container()
Destroy a container.
proton::container::connect
returned< connection > connect()
Connect using the default Connection Configuration file.
proton::container::container
container(messaging_handler &handler, const std::string &id)
Create a container with a global handler for messaging events.
proton::container::container
container(messaging_handler &handler)
Create a container with a global handler for messaging events.
proton::listener
A listener for incoming connections.
Definition: listener.hpp:33
proton::container
A top-level container of connections, sessions, and links.
Definition: container.hpp:50
proton::container::listen
listener listen(const std::string &listen_url, const connection_options &conn_opts)
Listen for new connections on listen_url.
fwd.hpp
Forward declarations.
proton::container::open_sender
returned< sender > open_sender(const std::string &addr_url, const proton::sender_options &snd_opts)
Open a connection and sender for addr_url.
proton::container::listen
listener listen(const std::string &listen_url, listen_handler &handler)
Listen for new connections on listen_url.
proton::receiver_options
Options for creating a receiver.
Definition: receiver_options.hpp:56
proton::container::server_connection_options
connection_options server_connection_options() const
Connection options applied to incoming connections.
proton::container::open_receiver
returned< receiver > open_receiver(const std::string &addr_url, const proton::receiver_options &rcv_opts)
Open a connection and receiver for addr_url.
proton::connection_options
Options for creating a connection.
Definition: connection_options.hpp:67
proton::duration
A span of time in milliseconds.
Definition: duration.hpp:39
proton::container::client_connection_options
void client_connection_options(const connection_options &conn_opts)
Connection options applied to outgoing connections.
proton::container::container
container(const std::string &id)
Create a container.
proton::container::id
std::string id() const
A unique identifier for the container.
proton::sender_options
Options for creating a sender.
Definition: sender_options.hpp:57
proton::messaging_handler
Handler for Proton messaging events.
Definition: messaging_handler.hpp:69
proton::session_options
Options for creating a session.
Definition: session_options.hpp:40
proton::container::auto_stop
void auto_stop(bool enabled)
Enable or disable automatic container stop.
proton::container::open_sender
returned< sender > open_sender(const std::string &addr_url, const connection_options &conn_opts)
Open a connection and sender for addr_url.
proton::returned
A return type for container methods.
Definition: returned.hpp:51
proton::container::open_sender
returned< sender > open_sender(const std::string &addr_url, const proton::sender_options &snd_opts, const connection_options &conn_opts)
Open a connection and sender for addr_url.
proton::container::stop
void stop()
Stop the container with an empty error condition.
proton::container::sender_options
class sender_options sender_options() const
Sender options applied to senders created by this container.
proton::listen_handler
Unsettled API - A handler for incoming connections.
Definition: listen_handler.hpp:39
proton::container::listen
listener listen(const std::string &listen_url)
Listen for new connections on listen_url.
proton::container::run
void run()
Run the container in the current thread.
proton::container::connect
returned< connection > connect(const std::string &conn_url, const connection_options &conn_opts)
Connect to conn_url and send an open request to the remote peer.
proton
The main Proton namespace.
Definition: annotation_key.hpp:33
proton::container::server_connection_options
void server_connection_options(const connection_options &conn_opts)
Connection options applied to incoming connections.
returned.hpp
A return type for container methods.
proton::container::open_receiver
returned< receiver > open_receiver(const std::string &addr_url, const proton::receiver_options &rcv_opts, const connection_options &conn_opts)
Open a connection and receiver for addr_url.
proton::container::open_receiver
returned< receiver > open_receiver(const std::string &addr_url)
Open a connection and receiver for addr_url.
proton::container::receiver_options
class receiver_options receiver_options() const
Receiver options applied to receivers created by this container.
proton::container::open_sender
returned< sender > open_sender(const std::string &addr_url)
Open a connection and sender for addr_url.
proton::container::open_receiver
returned< receiver > open_receiver(const std::string &addr_url, const connection_options &conn_opts)
Open a connection and receiver for addr_url.
proton::container::client_connection_options
connection_options client_connection_options() const
Connection options applied to outgoing connections.
proton::work_queue
Unsettled API - A context for thread-safe execution of work.
Definition: work_queue.hpp:339
proton::container::connect
returned< connection > connect(const std::string &conn_url)
Connect using the default Connection Configuration file.
types_fwd.hpp
Forward declarations for Proton types used to represent AMQP types.