Torque3D/Engine/source/app/net/tcpObject.h

//-----------------------------------------------------------------------------
// Copyright (c) 2012 GarageGames, LLC
//
// 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.
//-----------------------------------------------------------------------------

#ifndef _TCPOBJECT_H_
#define _TCPOBJECT_H_

#ifndef _SIMBASE_H_
#include "console/simBase.h"
#endif

#include "platform/platformNet.h"

class TCPObject : public SimObject
{
public:
   enum State {Disconnected, DNSResolved, Connected, Listening };

	DECLARE_CALLBACK(void, onConnectionRequest, (const char* address, const char* ID));
	DECLARE_CALLBACK(void, onLine, (const char* line));
	DECLARE_CALLBACK(bool, onPacket, (const char* data));
	DECLARE_CALLBACK(void, onEndReceive, ());
	DECLARE_CALLBACK(void, onDNSResolved,());
	DECLARE_CALLBACK(void, onDNSFailed, ());
	DECLARE_CALLBACK(void, onConnected, ());
	DECLARE_CALLBACK(void, onConnectFailed, ());
	DECLARE_CALLBACK(void, onDisconnect, ());

private:
   NetSocket mTag;
   TCPObject *mNext;
   enum { TableSize = 256, TableMask = 0xFF };
   static TCPObject *table[TableSize];
   State mState;

protected:
   typedef SimObject Parent;
   U8 *mBuffer;
   U32 mBufferSize;
   U16 mPort;

public:
   TCPObject();
   virtual ~TCPObject();

   void parseLine(U8 *buffer, U32 *start, U32 bufferLen);
   bool finishLastLine();
   bool isBufferEmpty();
   void emptyBuffer();

   static TCPObject *find(NetSocket tag);

   // onReceive gets called continuously until all bytes are processed
   // return # of bytes processed each time.
   virtual U32 onReceive(U8 *buffer, U32 bufferLen); // process a buffer of raw packet data
   virtual bool processLine(UTF8 *line); // process a complete line of text... default action is to call into script
   virtual void onDNSResolved();
   virtual void onDNSFailed();
   virtual void onConnected();
   virtual void onConnectFailed();
   virtual void onConnectionRequest(const NetAddress *addr, U32 connectId);
   virtual void onDisconnect();
   void connect(const char *address);
   void listen(U16 port);
   void disconnect();
   State getState() { return mState; }

   bool processArguments(S32 argc, ConsoleValue *argv);
   void send(const U8 *buffer, U32 bufferLen);

   ///Send an entire file over tcp
   ///@arg fileName Full path to file you want to send
   ///@return true if file was sent, false if not (file doesn't exist)
   bool sendFile(const char* fileName);

   void addToTable(NetSocket newTag);
   void removeFromTable();

   void setPort(U16 port) { mPort = port; }

   bool onAdd();

   DECLARE_CONOBJECT(TCPObject);

};


#endif  // _H_TCPOBJECT_