Open3D (C++ API)  0.12.0
MessageUtils.h
Go to the documentation of this file.
1 // ----------------------------------------------------------------------------
2 // - Open3D: www.open3d.org -
3 // ----------------------------------------------------------------------------
4 // The MIT License (MIT)
5 //
6 // Copyright (c) 2020 www.open3d.org
7 //
8 // Permission is hereby granted, free of charge, to any person obtaining a copy
9 // of this software and associated documentation files (the "Software"), to deal
10 // in the Software without restriction, including without limitation the rights
11 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 // copies of the Software, and to permit persons to whom the Software is
13 // furnished to do so, subject to the following conditions:
14 //
15 // The above copyright notice and this permission notice shall be included in
16 // all copies or substantial portions of the Software.
17 //
18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 // IN THE SOFTWARE.
25 // ----------------------------------------------------------------------------
26 
27 #pragma once
28 
30 
31 namespace zmq {
32 class message_t;
33 }
34 
35 namespace open3d {
36 namespace io {
37 namespace rpc {
38 
39 namespace messages {
40 struct Status;
41 }
42 
56 std::shared_ptr<messages::Status> UnpackStatusFromReply(
57  const zmq::message_t& msg, size_t& offset, bool& ok);
58 
60 bool ReplyIsOKStatus(const zmq::message_t& msg);
61 
64 bool ReplyIsOKStatus(const zmq::message_t& msg, size_t& offset);
65 
67 std::string CreateSerializedRequestMessage(const std::string& msg_id);
68 
69 std::tuple<const void*, size_t> GetZMQMessageDataAndSize(
70  const zmq::message_t& msg);
71 
72 std::tuple<int32_t, std::string> GetStatusCodeAndStr(
73  const messages::Status& status);
74 
75 std::shared_ptr<zmq::message_t> CreateStatusOKMsg();
76 
77 } // namespace rpc
78 } // namespace io
79 } // namespace open3d
std::string CreateSerializedRequestMessage(const std::string &msg_id)
Creates a serialized Request message for testing purposes.
Definition: MessageUtils.cpp:83
std::tuple< int32_t, std::string > GetStatusCodeAndStr(const messages::Status &status)
Definition: MessageUtils.cpp:95
int offset
Definition: FilePCD.cpp:64
std::shared_ptr< zmq::message_t > CreateStatusOKMsg()
Definition: MessageUtils.cpp:100
std::tuple< const void *, size_t > GetZMQMessageDataAndSize(const zmq::message_t &msg)
Definition: MessageUtils.cpp:90
bool ReplyIsOKStatus(const zmq::message_t &msg)
Convenience function for checking if the message is an OK.
Definition: MessageUtils.cpp:69
Definition: PinholeCameraIntrinsic.cpp:35
Definition: ConnectionBase.h:31
std::shared_ptr< messages::Status > UnpackStatusFromReply(const zmq::message_t &msg, size_t &offset, bool &ok)
Definition: MessageUtils.cpp:40