Skip to content

Commit 1aae1b8

Browse files
committed
Updating the doc comments on AsyncRequestHandler.
1 parent c62e0ec commit 1aae1b8

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

lldb/tools/lldb-dap/Handler/RequestHandler.h

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -181,10 +181,10 @@ class RequestHandler : public BaseRequestHandler {
181181
/// A Reply<T> is a void function that accepts a reply to an async request.
182182
template <typename T> using Reply = llvm::unique_function<void(T) const>;
183183

184-
/// Base class for handling DAP requests. Handlers should declare their
185-
/// arguments and response body types like:
184+
/// Base class for handling DAP requests asynchronously. Handlers should declare
185+
/// their arguments and response body types like:
186186
///
187-
/// class MyRequestHandler : public RequestHandler<Arguments, Response> {
187+
/// class MyRequestHandler : public AsyncRequestHandler<Arguments, Response> {
188188
/// ....
189189
/// };
190190
template <typename Args, typename Resp>
@@ -232,6 +232,9 @@ class AsyncRequestHandler : public BaseRequestHandler {
232232
});
233233
};
234234

235+
/// Run the request handler. The reply callback is expected to be invoked only
236+
/// once and may be moved to be handled at a later time. Returning from the
237+
/// `Run` call will unblock handling the next request.
235238
virtual void Run(const Args &, Reply<Resp>) const = 0;
236239
};
237240

0 commit comments

Comments
 (0)