MongoDB C++ Driver  mongocxx-3.6.2
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
command_started_event.hpp
1 // Copyright 2018-present MongoDB Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #pragma once
16 
17 #include <memory>
18 
19 #include <bsoncxx/document/view.hpp>
20 
21 #include <mongocxx/config/prelude.hpp>
22 
23 namespace mongocxx {
24 MONGOCXX_INLINE_NAMESPACE_BEGIN
25 
26 namespace events {
27 
34 class MONGOCXX_API command_started_event {
35  public:
36  MONGOCXX_PRIVATE explicit command_started_event(const void* event);
37 
42 
49 
55  bsoncxx::stdx::string_view database_name() const;
56 
62  bsoncxx::stdx::string_view command_name() const;
63 
69  std::int64_t request_id() const;
70 
76  std::int64_t operation_id() const;
77 
83  bsoncxx::stdx::string_view host() const;
84 
90  std::uint16_t port() const;
91 
92  private:
93  const void* _started_event;
94 };
95 
96 } // namespace events
97 MONGOCXX_INLINE_NAMESPACE_END
98 } // namespace mongocxx
99 
100 #include <mongocxx/config/postlude.hpp>
mongocxx
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
mongocxx::events::command_started_event::~command_started_event
~command_started_event()
Destroys a command_started_event.
mongocxx::events::command_started_event::request_id
std::int64_t request_id() const
Returns the request id.
mongocxx::events::command_started_event::database_name
bsoncxx::stdx::string_view database_name() const
Returns the name of the database.
mongocxx::events::command_started_event::port
std::uint16_t port() const
Returns the port.
mongocxx::events::command_started_event::command_name
bsoncxx::stdx::string_view command_name() const
Returns the name of the command.
mongocxx::events::command_started_event::host
bsoncxx::stdx::string_view host() const
Returns the host name.
mongocxx::events::command_started_event::command
bsoncxx::document::view command() const
Returns the command that has been started.
mongocxx::events::command_started_event
An event notification sent when the driver begins executing a MongoDB command.
Definition: command_started_event.hpp:34
mongocxx::events::command_started_event::operation_id
std::int64_t operation_id() const
Returns the operation id.
bsoncxx::document::view
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33