GRPC C++
0.11.0.0
Main Page
Namespaces
Data Structures
Files
File List
Globals
All
Data Structures
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
include
grpc++
security
auth_metadata_processor.h
Go to the documentation of this file.
1
/*
2
*
3
* Copyright 2015, Google Inc.
4
* All rights reserved.
5
*
6
* Redistribution and use in source and binary forms, with or without
7
* modification, are permitted provided that the following conditions are
8
* met:
9
*
10
* * Redistributions of source code must retain the above copyright
11
* notice, this list of conditions and the following disclaimer.
12
* * Redistributions in binary form must reproduce the above
13
* copyright notice, this list of conditions and the following disclaimer
14
* in the documentation and/or other materials provided with the
15
* distribution.
16
* * Neither the name of Google Inc. nor the names of its
17
* contributors may be used to endorse or promote products derived from
18
* this software without specific prior written permission.
19
*
20
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
*
32
*/
33
34
#ifndef GRPCXX_AUTH_METADATA_PROCESSOR_H_
35
#define GRPCXX_AUTH_METADATA_PROCESSOR_H_
36
37
#include <map>
38
39
#include <
grpc++/security/auth_context.h
>
40
#include <
grpc++/support/status.h
>
41
#include <
grpc++/support/string_ref.h
>
42
43
namespace
grpc {
44
45
class
AuthMetadataProcessor
{
46
public
:
47
typedef
std::multimap<grpc::string_ref, grpc::string_ref>
InputMetadata
;
48
typedef
std::multimap<grpc::string, grpc::string_ref>
OutputMetadata
;
49
50
virtual
~AuthMetadataProcessor
() {}
51
52
// If this method returns true, the Process function will be scheduled in
53
// a different thread from the one processing the call.
54
virtual
bool
IsBlocking
()
const
{
return
true
; }
55
56
// context is read/write: it contains the properties of the channel peer and
57
// it is the job of the Process method to augment it with properties derived
58
// from the passed-in auth_metadata.
59
// consumed_auth_metadata needs to be filled with metadata that has been
60
// consumed by the processor and will be removed from the call.
61
// response_metadata is the metadata that will be sent as part of the
62
// response.
63
// If the return value is not Status::OK, the rpc call will be aborted with
64
// the error code and error message sent back to the client.
65
virtual
Status
Process
(
const
InputMetadata
& auth_metadata,
66
AuthContext
* context,
67
OutputMetadata
* consumed_auth_metadata,
68
OutputMetadata
* response_metadata) = 0;
69
};
70
71
}
// namespace grpc
72
73
#endif // GRPCXX_AUTH_METADATA_PROCESSOR_H_
74
string_ref.h
grpc::AuthMetadataProcessor::IsBlocking
virtual bool IsBlocking() const
Definition:
auth_metadata_processor.h:54
grpc::AuthContext
Class encapsulating the Authentication Information.
Definition:
auth_context.h:81
grpc::AuthMetadataProcessor
Definition:
auth_metadata_processor.h:45
grpc::AuthMetadataProcessor::~AuthMetadataProcessor
virtual ~AuthMetadataProcessor()
Definition:
auth_metadata_processor.h:50
auth_context.h
status.h
grpc::AuthMetadataProcessor::Process
virtual Status Process(const InputMetadata &auth_metadata, AuthContext *context, OutputMetadata *consumed_auth_metadata, OutputMetadata *response_metadata)=0
grpc::Status
Did it work? If it didn't, why?
Definition:
status.h:45
grpc::AuthMetadataProcessor::OutputMetadata
std::multimap< grpc::string, grpc::string_ref > OutputMetadata
Definition:
auth_metadata_processor.h:48
grpc::AuthMetadataProcessor::InputMetadata
std::multimap< grpc::string_ref, grpc::string_ref > InputMetadata
Definition:
auth_metadata_processor.h:47
Generated on Thu Sep 3 2015 09:44:14 for GRPC C++ by
1.8.6