summaryrefslogtreecommitdiff
path: root/gps/utils/LocIpc.h
diff options
context:
space:
mode:
authorIsaac Chen <isaacchen@isaacchen.cn>2018-12-31 10:55:08 +0100
committerTingyiChen <tingyi364@gmail.com>2019-08-13 11:54:40 +0200
commite5c53750f06e9d9739b45ec108260ead7ff80941 (patch)
treefe1d84884caefc481e994ae9c59c84b11fddd408 /gps/utils/LocIpc.h
parent3ac2a0309619515c9ac27a5b6ec7c212b86dc355 (diff)
wayne-common: Synchorize gps to P
* QC Tag: LA.UM.7.2.r1-04900-sdm660.0 Signed-off-by: Isaac Chen <isaacchen@isaacchen.cn> Change-Id: I34383e8fbf394b774f83f8d662873e8786ff1bbf
Diffstat (limited to 'gps/utils/LocIpc.h')
-rw-r--r--gps/utils/LocIpc.h153
1 files changed, 153 insertions, 0 deletions
diff --git a/gps/utils/LocIpc.h b/gps/utils/LocIpc.h
new file mode 100644
index 0000000..364093b
--- /dev/null
+++ b/gps/utils/LocIpc.h
@@ -0,0 +1,153 @@
+/* Copyright (c) 2017-2018 The Linux Foundation. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided
+ * with the distribution.
+ * * Neither the name of The Linux Foundation, nor the names of its
+ * contributors may be used to endorse or promote products derived
+ * from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+ * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+ * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+ * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+#ifndef __LOC_SOCKET__
+#define __LOC_SOCKET__
+
+#include <string>
+#include <memory>
+#include <unistd.h>
+#include <sys/socket.h>
+#include <sys/un.h>
+#include <LocThread.h>
+
+namespace loc_util {
+
+class LocIpcSender;
+
+class LocIpc {
+friend LocIpcSender;
+public:
+ inline LocIpc() : mIpcFd(-1), mStopRequested(false), mRunnable(nullptr) {}
+ inline virtual ~LocIpc() { stopListening(); }
+
+ // Listen for new messages in current thread. Calling this funciton will
+ // block current thread. The listening can be stopped by calling stopListening().
+ //
+ // Argument name is the path of the unix local socket to be listened.
+ // The function will return true on success, and false on failure.
+ bool startListeningBlocking(const std::string& name);
+
+ // Create a new LocThread and listen for new messages in it.
+ // Calling this function will return immediately and won't block current thread.
+ // The listening can be stopped by calling stopListening().
+ //
+ // Argument name is the path of the unix local socket to be be listened.
+ // The function will return true on success, and false on failure.
+ bool startListeningNonBlocking(const std::string& name);
+
+ // Stop listening to new messages.
+ void stopListening();
+
+ // Send out a message.
+ // Call this function to send a message in argument data to socket in argument name.
+ //
+ // Argument name contains the name of the target unix socket. data contains the
+ // message to be sent out. Convert your message to a string before calling this function.
+ // The function will return true on success, and false on failure.
+ static bool send(const char name[], const std::string& data);
+ static bool send(const char name[], const uint8_t data[], uint32_t length);
+
+protected:
+ // Callback function for receiving incoming messages.
+ // Override this function in your derived class to process incoming messages.
+ // For each received message, this callback function will be called once.
+ // This callback function will be called in the calling thread of startListeningBlocking
+ // or in the new LocThread created by startListeningNonBlocking.
+ //
+ // Argument data contains the received message. You need to parse it.
+ inline virtual void onReceive(const std::string& /*data*/) {}
+
+ // LocIpc client can overwrite this function to get notification
+ // when the socket for LocIpc is ready to receive messages.
+ inline virtual void onListenerReady() {}
+
+private:
+ static bool sendData(int fd, const sockaddr_un& addr,
+ const uint8_t data[], uint32_t length);
+
+ int mIpcFd;
+ bool mStopRequested;
+ LocThread mThread;
+ LocRunnable *mRunnable;
+};
+
+class LocIpcSender {
+public:
+ // Constructor of LocIpcSender class
+ //
+ // Argument destSocket contains the full path name of destination socket.
+ // This class hides generated fd and destination address object from user.
+ inline LocIpcSender(const char* destSocket):
+ LocIpcSender(std::make_shared<int>(::socket(AF_UNIX, SOCK_DGRAM, 0)), destSocket) {
+ if (-1 == *mSocket) {
+ mSocket = nullptr;
+ }
+ }
+
+ // Replicate a new LocIpcSender object with new destination socket.
+ inline LocIpcSender* replicate(const char* destSocket) {
+ return (nullptr == mSocket) ? nullptr : new LocIpcSender(mSocket, destSocket);
+ }
+
+ inline ~LocIpcSender() {
+ if (nullptr != mSocket && mSocket.unique()) {
+ ::close(*mSocket);
+ }
+ }
+
+ // Send out a message.
+ // Call this function to send a message
+ //
+ // Argument data and length contains the message to be sent out.
+ // Return true when succeeded
+ inline bool send(const uint8_t data[], uint32_t length) {
+ bool rtv = false;
+ if (nullptr != mSocket && nullptr != data) {
+ rtv = LocIpc::sendData(*mSocket, mDestAddr, data, length);
+ }
+ return rtv;
+ }
+
+private:
+ std::shared_ptr<int> mSocket;
+ struct sockaddr_un mDestAddr;
+
+ inline LocIpcSender(
+ const std::shared_ptr<int>& mySocket, const char* destSocket) : mSocket(mySocket) {
+ if ((nullptr != mSocket) && (-1 != *mSocket) && (nullptr != destSocket)) {
+ mDestAddr.sun_family = AF_UNIX;
+ snprintf(mDestAddr.sun_path, sizeof(mDestAddr.sun_path), "%s", destSocket);
+ }
+ }
+};
+
+}
+
+#endif //__LOC_SOCKET__