1 /* 2 * Copyright (c) 2016, The Linux Foundation. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * * Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * * Redistributions in binary form must reproduce the above 10 * copyright notice, this list of conditions and the following 11 * disclaimer in the documentation and/or other materials provided 12 * with the distribution. 13 * * Neither the name of The Linux Foundation nor the names of its 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED 18 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 21 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 24 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 25 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 26 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 27 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 */ 29 30 /*! @file socket_handler.h 31 @brief Interface file for platform specific Socket Handler. 32 33 @details SDM will use this interface to get the platform specific Socket fd. 34 */ 35 36 #ifndef __SOCKET_HANDLER_H__ 37 #define __SOCKET_HANDLER_H__ 38 39 namespace sdm { 40 41 /*! @brief This enum represents Socket types, for which SDM can request the fd. 42 43 */ 44 enum SocketType { 45 kDpps, //!< Socket for Dpps 46 }; 47 48 /*! @brief Socket handler implemented by the client 49 50 @details This class declares prototype for SocketHandler methods which must be 51 implemented by client. SDM will use these methods to get the platform specific Socket fd. 52 53 @sa CoreInterface::CreateCore 54 */ 55 class SocketHandler { 56 public: 57 /*! @brief Method to get the platform specific Socket fd for a given socket type. 58 59 @details This method returns the platform specific Socket fd for a given socket type. 60 It is the responsibility of the caller to close the file descriptor. 61 62 @param[in] socket_type 63 64 @return \link int \endlink 65 */ 66 67 virtual int GetSocketFd(SocketType socket_type) = 0; 68 69 protected: 70 virtual ~SocketHandler() { } 71 }; 72 73 } // namespace sdm 74 75 #endif // __SOCKET_HANDLER_H__ 76
