server_socket.h

Go to the documentation of this file.

#include "sick_scan/sick_scan_base.h" /* Base definitions included in all header files, added by add_sick_scan_base_header.py. Do not edit this line. */
/*
 * @brief server_socket implements a server socket connection.
 *
 * Copyright (C) 2021 Ing.-Buero Dr. Michael Lehning, Hildesheim
 * Copyright (C) 2021 SICK AG, Waldkirch
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 *
 * 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 SICK AG nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission
 *     * Neither the name of Ing.-Buero Dr. Michael Lehning 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 BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * 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.
 *
 *      Authors:
 *         Michael Lehning <michael.lehning@lehning.de>
 *
 *  Copyright 2021 SICK AG
 *  Copyright 2021 Ing.-Buero Dr. Michael Lehning
 *
 */
#ifndef __SERVER_SOCKET_H_INCLUDED
#define __SERVER_SOCKET_H_INCLUDED
 
#include <stdint.h>
 
#ifndef _MSC_VER        
  #include <fcntl.h>
  #include <unistd.h>
  #include <sys/types.h>
  #include <sys/stat.h>
  #include <sys/socket.h>
  #include <netinet/in.h>
  #include <sys/mman.h>
  #include <arpa/inet.h>
        typedef int32_t socket_t;
  #define INVALID_SOCKET (-1)
#else
  //#include <windows.h>
  #include <winsock2.h>
  typedef SOCKET socket_t;
#endif
 
namespace sick_scan_xd
{
  class ServerSocket
  {
  public:
 
    ServerSocket();
 
    virtual ~ServerSocket();
 
    virtual bool open(int tcp_port, bool bTcpAnyHost = false);
 
    virtual bool connect();
 
    virtual int read(int num_bytes, std::vector<uint8_t>& out_buffer, bool read_blocking = true);
 
    virtual bool read(int num_bytes, uint8_t* out_buffer, bool read_blocking = true);
 
    virtual bool write(const uint8_t* buffer, int num_bytes, int num_retries_on_error = 1);
 
    virtual void close(void);
 
    virtual bool is_open(void);
 
    // virtual socket_t& listenSocket(void) { return m_tListenSocket; }
    virtual socket_t& connectedSocket(void) { return m_tConnectedSocket; }
 
  protected:
 
    int      m_iListenPortNumber;
    socket_t m_tListenSocket;
    socket_t m_tConnectedSocket;
 
  }; // class ServerSocket
 
} // namespace sick_scan_xd
#endif // __SERVER_SOCKET_H_INCLUDED