socketconnection_base.h

#ifndef _SOCKET_CONNECTION_BASE_H_
#define _SOCKET_CONNECTION_BASE_H_

#include "packet.h"
#include "cl_semaphore.h"
#include "pcqueue.h"
#include "socketconnectionowner.h"
#include <string>

using namespace std;

typedef PCQueue<Packet*> PacketPtrSet;
typedef PCQueue<string*> StringPtrSet;

class SocketConnection_Base
{
public:
    /*
        SocketConnection

        Incoming packets will be placed in the buffer pointed to by input_buffer_ptr.

        Outgoing packets will be placed in the output buffer then sent at next opportunity.
    */
    SocketConnection_Base(SocketConnectionOwner* owner, PacketPtrSet* input_buffer_ptr);
    virtual ~SocketConnection_Base();

    /*
        Write

        Write a string to the socket.  This call will block if the socket connections
        outgoing buffer is full.

        Returns true if the packet was placed in the output buffer (but not whether it
        was sent).  If the socket connection is no longer available, returns false.
    */
    bool Write(const PacketType& type_arg, const PacketDataLength& data_length_arg, const char* data_arg);
    bool Write(const Packet& pkt);

    /*
        GetDescriptor

        Used to retrieve the file descriptor for the socket.
    */
    int GetDescriptor() const;

    /*
        SetDescriptor

        Used to set the file descriptor for the socket.
    */
    void SetDescriptor(int arg);

    /*
        Activate

        Used to initialize the threads used for reading to and
        writing from the socket.
    */
    virtual void Activate() = 0;
    virtual void Deactivate() = 0;
    virtual void PrepareServerConnection() = 0;
    virtual void PrepareClientConnection() = 0;
    //void IncrementPacketsOut();
    //bool DecrementPacketsOut();

    SocketConnectionOwner* GetOwner() const;

protected:
    /*
    object locking must be private.  The reason for this
    is that external parties should only be manipulating
    our data through our public interfaces, and our public
    interfaces should all be thread safe.  Therefore, these
    are private.
    */
    void Lock();
    void Unlock();
    StringPtrSet output_buffer;
    PacketPtrSet* input_buffer;

private:
    int descriptor;
    unsigned int packets_out;
    sem_t mutex;
    SocketConnectionOwner* _owner;


    // Disallow these because they represent corruptable communication
    bool Write(const char* cstring_arg);
    bool Write(const string& cstring_arg);
};


// Service Functions - to be implemented by server/client implementor
SocketConnection_Base* NewSocketConnection(SocketConnectionOwner* owner, PacketPtrSet* ppsp_arg);
void Delete(SocketConnection_Base* sc_arg);

#endif // _SOCKET_CONNECTION_BASE_H_

/*
------------------------------------------------------------------------------
This software is available under 2 licenses -- choose whichever you prefer.
------------------------------------------------------------------------------
ALTERNATIVE A - MIT License
Copyright (c) 2003-2019 Bobby G. Burrough
Permission is hereby granted, free of charge, to any person obtaining a copy of 
this software and associated documentation files (the "Software"), to deal in 
the Software without restriction, including without limitation the rights to 
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
of the Software, and to permit persons to whom the Software is furnished to do 
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
SOFTWARE.
------------------------------------------------------------------------------
ALTERNATIVE B - Public Domain (www.unlicense.org)
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this 
software, either in source code form or as a compiled binary, for any purpose, 
commercial or non-commercial, and by any means.
In jurisdictions that recognize copyright laws, the author or authors of this 
software dedicate any and all copyright interest in the software to the public 
domain. We make this dedication for the benefit of the public at large and to 
the detriment of our heirs and successors. We intend this dedication to be an 
overt act of relinquishment in perpetuity of all present and future rights to 
this software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
------------------------------------------------------------------------------
*/