1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/**
* Copyright (C) 2016 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include <memory>
#include "mongo/base/disallow_copying.h"
#include "mongo/base/status.h"
#include "mongo/stdx/functional.h"
#include "mongo/transport/ticket_impl.h"
#include "mongo/util/time_support.h"
namespace mongo {
namespace transport {
class Session;
class TransportLayer;
/**
* A Ticket represents some work to be done within the TransportLayer.
* Run Tickets by passing them in a call to either TransportLayer::wait()
* or TransportLayer::asyncWait().
*/
class Ticket {
MONGO_DISALLOW_COPYING(Ticket);
public:
using TicketCallback = stdx::function<void(Status)>;
friend class TransportLayer;
/**
* Indicates that there is no expiration time by when a ticket needs to complete.
*/
static const Date_t kNoExpirationDate;
static Status ExpiredStatus;
static Status SessionClosedStatus;
Ticket(TransportLayer* tl, std::unique_ptr<TicketImpl> ticket);
/**
* An invalid ticket and a Status for why it's invalid.
*/
Ticket(Status status);
~Ticket();
/**
* Move constructor and assignment operator.
*/
Ticket(Ticket&&);
Ticket& operator=(Ticket&&);
/**
* Return this ticket's session id.
*/
SessionId sessionId() const {
return _ticket->sessionId();
}
/**
* Return this ticket's expiration date.
*/
Date_t expiration() const {
return _ticket->expiration();
}
/**
* Wait for this ticket to be filled.
*
* This is this-rvalue qualified because it consumes the ticket
*/
Status wait() &&;
/**
* Asynchronously wait for this ticket to be filled.
*
* This is this-rvalue qualified because it consumes the ticket
*/
void asyncWait(TicketCallback cb) &&;
/*
* Return's the Status of the ticket.
*/
Status status() const;
/*
* Returns true if the ticket has expired, false otherwise.
*
* If the ticket has expired, changes the Status of the ticket to TicketExpired but
* only if the current Status is Status::OK().
*/
bool expired();
/*
* Return true if the ticket is usable, false otherwise.
*
* If the ticket has expired, changes the Status of the ticket to TicketExpired but
* only if the current Status is Status::OK().
*/
bool valid();
/**
* Return a non-owning pointer to the underlying TicketImpl type
*/
TicketImpl* impl() const {
return _ticket.get();
}
private:
TransportLayer* _tl;
Status _status = Status::OK();
std::unique_ptr<TicketImpl> _ticket;
};
} // namespace transport
} // namespace mongo
|
