MongoDB C++ Driver  mongocxx-3.9.0
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
command_failed_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 inline namespace v_noabi {
27 namespace events {
28 
35 class MONGOCXX_API command_failed_event {
36  public:
37  MONGOCXX_PRIVATE explicit command_failed_event(const void* event);
38 
43 
49  bsoncxx::document::view failure() const;
50 
56  bsoncxx::stdx::string_view command_name() const;
57 
63  std::int64_t duration() const;
64 
70  std::int64_t request_id() const;
71 
77  std::int64_t operation_id() const;
78 
84  bsoncxx::stdx::optional<bsoncxx::oid> service_id() const;
85 
91  bsoncxx::stdx::string_view host() const;
92 
98  std::uint16_t port() const;
99 
100  private:
101  const void* _failed_event;
102 };
103 
104 } // namespace events
105 } // namespace v_noabi
106 } // namespace mongocxx
107 
108 #include <mongocxx/config/postlude.hpp>
An event notification sent when the driver fails to execute a MongoDB command.
Definition: command_failed_event.hpp:35
std::int64_t operation_id() const
Returns the operation id.
bsoncxx::stdx::string_view host() const
Returns the host name.
bsoncxx::stdx::string_view command_name() const
Returns the name of the command.
std::int64_t duration() const
Returns the duration of the failed operation.
std::uint16_t port() const
Returns the port.
bsoncxx::document::view failure() const
Returns the server’s reply to the failed operation.
~command_failed_event()
Destroys a command_failed_event.
std::int64_t request_id() const
Returns the request id.
bsoncxx::stdx::optional< bsoncxx::oid > service_id() const
Optionally returns the service id.
The top-level namespace for mongocxx library entities.
Definition: bulk_write.hpp:24