summaryrefslogtreecommitdiff
path: root/automotive/can/1.0/default/libnl++/protocols/NetlinkProtocol.h
blob: b173b912705bfaffc8063bc9ed2d7a3202f55f28 (plain)
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
/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include "MessageDefinition.h"
#include "common/Empty.h"
#include "common/Error.h"

#include <libnl++/types.h>

#include <string>
#include <vector>

namespace android::nl::protocols {

/**
 * Netlink-based protocol definition.
 *
 * Usually it's just an id/name and a list of supported messages.
 */
class NetlinkProtocol {
  public:
    virtual ~NetlinkProtocol();

    int getProtocol() const;

    const std::string& getName() const;

    virtual const std::optional<std::reference_wrapper<MessageDescriptor>> getMessageDescriptor(
            nlmsgtype_t nlmsg_type);

  protected:
    typedef std::vector<std::shared_ptr<MessageDescriptor>> MessageDescriptorList;

    NetlinkProtocol(int protocol, const std::string& name,
                    const MessageDescriptorList&& messageDescrs);

  private:
    typedef std::map<nlmsgtype_t, std::shared_ptr<MessageDescriptor>> MessageDescriptorMap;

    const int mProtocol;
    const std::string mName;
    const MessageDescriptorMap mMessageDescrs;

    static MessageDescriptorMap toMap(const MessageDescriptorList& descrs, int protocol);
};

}  // namespace android::nl::protocols