CascadeClientSocket.h

Go to the documentation of this file.

// CascadeClientSocket.h : interface of class CascadeClientSocket
//
// Copyright (c) 2005, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_NET_CASCADECLIENTSOCKET_H
#define _ROKU_INCLUDE_CASCADE_NET_CASCADECLIENTSOCKET_H

#include <cascade/CascadeObject.h>

// class CascadeClientSocket - an easy to use socket for client connections
class CascadeClientSocket : public CascadeObject
{
public:
    CascadeClientSocket();
    virtual ~CascadeClientSocket();

public:
    enum Type  { kDatagram = 0, kStream };
    enum Error { kNoError = 0, kTimeout, kInvalidSocket, kSocketError, kOutOfMemory };
    enum       { kDefaultTimeoutMS = 5000 };

public:
    bool Open(Type type, const char * pRemoteServer, u16 nRemotePort, u32 nTimeoutMS = kDefaultTimeoutMS);
    bool Close();
    u32  Send(void * pData, u32 nDataLen, u32 nTimeoutMS = kDefaultTimeoutMS);
    bool SendAll(void * pData, u32 nDataLen, u32 nTimeoutMS = kDefaultTimeoutMS);
    u32  Receive(void * pDataToSet, u32 nDataLen, u32 nTimeoutMS = kDefaultTimeoutMS);
    bool ReceiveAll(void * pDataToSet, u32 nDataLen, u32 nTimeoutMS = kDefaultTimeoutMS);
    Error GetLastError();

private:
    class Socket;
    Socket * m_pSocket;
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_NET_CASCADECLIENTSOCKET_H

//      LOG 
//  18-May-05   dwoodward   created

---