FairMQ  1.4.33
C++ Message Queuing Library and Framework
TransportFactory.h
1 /********************************************************************************
2  * Copyright (C) 2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *
3  * *
4  * This software is distributed under the terms of the *
5  * GNU Lesser General Public Licence (LGPL) version 3, *
6  * copied verbatim in the file "LICENSE" *
7  ********************************************************************************/
8 
9 #ifndef FAIR_MQ_OFI_TRANSPORTFACTORY_H
10 #define FAIR_MQ_OFI_TRANSPORTFACTORY_H
11 
12 #include <FairMQTransportFactory.h>
13 #include <fairmq/ProgOptions.h>
14 #include <fairmq/ofi/Context.h>
15 
16 #include <asiofi.hpp>
17 
18 namespace fair::mq::ofi
19 {
20 
27 class TransportFactory final : public FairMQTransportFactory
28 {
29  public:
30  TransportFactory(const std::string& id = "", const fair::mq::ProgOptions* config = nullptr);
31  TransportFactory(const TransportFactory&) = delete;
32  TransportFactory operator=(const TransportFactory&) = delete;
33 
34  auto CreateMessage() -> MessagePtr override;
35  auto CreateMessage(Alignment alignment) -> MessagePtr override;
36  auto CreateMessage(const std::size_t size) -> MessagePtr override;
37  auto CreateMessage(const std::size_t size, Alignment alignment) -> MessagePtr override;
38  auto CreateMessage(void* data, const std::size_t size, fairmq_free_fn* ffn, void* hint = nullptr) -> MessagePtr override;
39  auto CreateMessage(UnmanagedRegionPtr& region, void* data, const std::size_t size, void* hint = nullptr) -> MessagePtr override;
40 
41  auto CreateSocket(const std::string& type, const std::string& name) -> SocketPtr override;
42 
43  auto CreatePoller(const std::vector<FairMQChannel>& channels) const -> PollerPtr override;
44  auto CreatePoller(const std::vector<FairMQChannel*>& channels) const -> PollerPtr override;
45  auto CreatePoller(const std::unordered_map<std::string, std::vector<FairMQChannel>>& channelsMap, const std::vector<std::string>& channelList) const -> PollerPtr override;
46 
47  auto CreateUnmanagedRegion(const size_t size, RegionCallback callback = nullptr, const std::string& path = "", int flags = 0) -> UnmanagedRegionPtr override;
48  auto CreateUnmanagedRegion(const size_t size, RegionBulkCallback callback = nullptr, const std::string& path = "", int flags = 0) -> UnmanagedRegionPtr override;
49  auto CreateUnmanagedRegion(const size_t size, int64_t userFlags, RegionCallback callback = nullptr, const std::string& path = "", int flags = 0) -> UnmanagedRegionPtr override;
50  auto CreateUnmanagedRegion(const size_t size, int64_t userFlags, RegionBulkCallback callback = nullptr, const std::string& path = "", int flags = 0) -> UnmanagedRegionPtr override;
51 
52  void SubscribeToRegionEvents(RegionEventCallback /* callback */) override { LOG(error) << "SubscribeToRegionEvents not yet implemented for OFI"; }
53  bool SubscribedToRegionEvents() override { LOG(error) << "Region event subscriptions not yet implemented for OFI"; return false; }
54  void UnsubscribeFromRegionEvents() override { LOG(error) << "UnsubscribeFromRegionEvents not yet implemented for OFI"; }
55  std::vector<FairMQRegionInfo> GetRegionInfo() override { LOG(error) << "GetRegionInfo not yet implemented for OFI, returning empty vector"; return std::vector<FairMQRegionInfo>(); }
56 
57  auto GetType() const -> Transport override;
58 
59  void Interrupt() override { fContext.Interrupt(); }
60  void Resume() override { fContext.Resume(); }
61  void Reset() override { fContext.Reset(); }
62 
63  private:
64  mutable Context fContext;
65  asiofi::allocated_pool_resource fMemoryResource;
66 }; /* class TransportFactory */
67 
68 } // namespace fair::mq::ofi
69 
70 #endif /* FAIR_MQ_OFI_TRANSPORTFACTORY_H */
fair::mq::Alignment
Definition: FairMQMessage.h:25
fair::mq::ProgOptions
Definition: ProgOptions.h:41
fair::mq::ofi::TransportFactory::CreateMessage
auto CreateMessage() -> MessagePtr override
Create empty FairMQMessage (for receiving)
Definition: TransportFactory.cxx:40
fair::mq::ofi::TransportFactory::CreateSocket
auto CreateSocket(const std::string &type, const std::string &name) -> SocketPtr override
Create a socket.
fair::mq::ofi::TransportFactory::GetType
auto GetType() const -> Transport override
Get transport type.
Definition: TransportFactory.cxx:121
fair::mq::ofi::TransportFactory::SubscribedToRegionEvents
bool SubscribedToRegionEvents() override
Check if there is an active subscription to region events.
Definition: TransportFactory.h:59
fair::mq::ofi::TransportFactory::CreateUnmanagedRegion
auto CreateUnmanagedRegion(const size_t size, RegionCallback callback=nullptr, const std::string &path="", int flags=0) -> UnmanagedRegionPtr override
Create new UnmanagedRegion.
Definition: TransportFactory.cxx:101
fair::mq::ofi::TransportFactory::UnsubscribeFromRegionEvents
void UnsubscribeFromRegionEvents() override
Unsubscribe from region events.
Definition: TransportFactory.h:60
fair::mq::ofi::TransportFactory::SubscribeToRegionEvents
void SubscribeToRegionEvents(RegionEventCallback) override
Subscribe to region events (creation, destruction, ...)
Definition: TransportFactory.h:58
fair::mq::ofi::TransportFactory::CreatePoller
auto CreatePoller(const std::vector< FairMQChannel > &channels) const -> PollerPtr override
Create a poller for a single channel (all subchannels)
FairMQTransportFactory
Definition: FairMQTransportFactory.h:30

privacy