1 /* 2 * Copyright (c) 2011-2014, Intel Corporation 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without modification, 6 * are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, this 9 * list of conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright notice, 12 * this list of conditions and the following disclaimer in the documentation and/or 13 * other materials provided with the distribution. 14 * 15 * 3. Neither the name of the copyright holder nor the names of its contributors 16 * may be used to endorse or promote products derived from this software without 17 * specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 #pragma once 31 32 #include <string> 33 #include <stdint.h> 34 35 struct sockaddr_in; 36 struct in_addr; 37 38 /** Readable and writable socket. 39 * 40 * The class does not encapsulate completely it's internal file descriptor as 41 * it can be retrieve by the getFd method. 42 * 43 * This "feature" means that it's state consistency can not 44 * be enforced by the class but rather by clients. 45 */ 46 class CSocket 47 { 48 public: 49 CSocket(); 50 CSocket(int iSockId); 51 virtual ~CSocket(); 52 53 // Non blocking state 54 void setNonBlocking(bool bNonBlocking); 55 56 // Communication timeout 57 void setTimeout(uint32_t uiMilliseconds); 58 59 /* Read data 60 * 61 * On failure errno will be set appropriately (see send). 62 * If the client disconnects, false will be returned and 63 * - hasPeerDisconnected will return true 64 * - errno is set to ECONNRESET. 65 * @param[in] pvData - on success: will contain the sent data 66 * - on failure: undefined 67 * @param[in] uiSize size of the data to receive. 68 * 69 * @return true if all data could be read, false otherwise. 70 */ 71 bool read(void* pvData, uint32_t uiSize); 72 73 /* Write data 74 * 75 * On failure errno will be set (see recv) 76 * @param[in] pvData data to send. 77 * @param[in] uiSize is the size of the data to send. 78 * 79 * @return true if all data could be read, false otherwise. 80 */ 81 bool write(const void* pvData, uint32_t uiSize); 82 83 /** @return the managed file descriptor. 84 * 85 * The client can then bind/connect/accept/listen/... the socket. 86 */ 87 int getFd() const; 88 89 /** @return true if the peer has disconnected. 90 * 91 * The internal fd is returned by getFd and clients can use it for 92 * bind/connect/read/write/... as a result it's state can not be tracked. 93 * 94 * Thus hasPeerDisconnected returns true only if the disconnection 95 * was notified during a call to CSocket::write or CSocket::read. 96 */ 97 bool hasPeerDisconnected(); 98 99 protected: 100 // Socket address init 101 void initSockAddrIn(struct sockaddr_in* pSockAddrIn, uint32_t uiInAddr, uint16_t uiPort) const; 102 private: 103 int _iSockFd; 104 /** If the peer disconnected. 105 * 106 * This is not the state of _iSockFd (connected/disconnected) 107 * 108 * See hasPeerDisconnected for more details. 109 */ 110 bool _disconnected; 111 int mSendFlag; 112 }; 113