MongoDB C++ Driver  mongocxx-3.7.0
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 #include <bsoncxx/oid.hpp>
21 #include <bsoncxx/stdx/optional.hpp>
22 
23 #include <mongocxx/config/prelude.hpp>
24 
25 namespace mongocxx {
26 MONGOCXX_INLINE_NAMESPACE_BEGIN
27 
28 namespace events {
29 
36 class MONGOCXX_API command_started_event {
37  public:
38  MONGOCXX_PRIVATE explicit command_started_event(const void* event);
39 
44 
50  bsoncxx::document::view command() const;
51 
57  bsoncxx::stdx::string_view database_name() const;
58 
64  bsoncxx::stdx::string_view command_name() const;
65 
71  std::int64_t request_id() const;
72 
78  std::int64_t operation_id() const;
79 
85  bsoncxx::stdx::optional<bsoncxx::oid> service_id() const;
86 
92  bsoncxx::stdx::string_view host() const;
93 
99  std::uint16_t port() const;
100 
101  private:
102  const void* _started_event;
103 };
104 
105 } // namespace events
106 MONGOCXX_INLINE_NAMESPACE_END
107 } // namespace mongocxx
108 
109 #include <mongocxx/config/postlude.hpp>
mongocxx
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
mongocxx::events::command_started_event
An event notification sent when the driver begins executing a MongoDB command.
Definition: command_started_event.hpp:36
bsoncxx::document::view
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33