#include <SFBSocket.h.hpp>

class SFBSocket : public SFBAStream;

SFMTYPEDEFWRAPPER(SFBSocket)

[ public ]
SFCError Accept(
    SFBSocketSmpPtr socket   // pointer to the newly accepted SFBSocket interface 
);

[ public ]
SFCError Bind(
    INAddr addr   // IP Address
    INPort port   // port
);

[ public ]
SFCError Bind(
    SFXSocketAddressConstRef dest   // IP Address and Port
);

[ public ]
Void Cancel(
    PFNNOTIFY notify = null   // pointer to the callback function that needs to be cancelled
    VoidPtr data = null       // callback data that was used to register the callback
);

[ public ]
SFCError Close(Void);

[ public ]
SFCError Connect(
    INAddr addr           // IP Address
    INPort port           // port
    PFNCONNECTCB notify   // address of the callback function that is invoked
                          // by AEE when the connect operation either succeeds or fails
    VoidPtr data = null   // user-defined data that is passed to the callback function when it is invoked
);

[ public ]
SFCError Connect(
    SFXSocketAddressConstRef dest   // IP Address and Port
    PFNCONNECTCB notify             // address of the callback function that is invoked
                                    // by AEE when the connect operation either succeeds or fails
    VoidPtr data = null             // user-defined data that is passed to the callback function when it is invoked
);

[ public ]
Void DbgMark(
    ACharConstPtr file   // __FILE__ 
    UInt32 line          // __LINE__ 
);

[ public ]
SFCError GetLastError(Void);

[ public ]
SFCError GetOpt(
    SInt32 level        // option level (see AEESockOpt)
    SInt32 optName      // option name (see AEESockOpt) 
    VoidPtr optVal      // pointer to the data type appropriate for the option
    SInt32Ptr optSize   // pointer to size of optVal
);

[ public ]
SFCError GetOpt(
    SInt32 level       // option level (see AEESockOpt) 
    SInt32 optName     // option name (see AEESockOpt) 
    SFXBufferPtr opt   // pointer to the buffer appropriate for the option
);

[ public ]
SFCError GetPeerName(
    INAddr* addr   // pointer to the IP Address in network byte order 
    INPort* port   // pointer to the port in network byte order
);

[ public ]
SFCError GetPeerName(
    SFXSocketAddressPtr dest   // pointer to the SFXSocketAddress
);

[ public ]
SFXSocketAddress GetPeerName(Void);

[ public ]
SFCError GetSDBAckInfo(
    AEESDBAckInfo * info   // pointer to a AEESDBAckInfo structure
);

[ public ]
SFCError GetSockName(
    INAddr* addr   // pointer to the IP Address t in network byte order
    INPort* port   // pointer to the IP Address t in network byte order
);

[ public ]
SFCError GetSockName(
    SFXSocketAddressPtr dest   // pointer to the SFXSocketAddress
);

[ public ]
SFXSocketAddress GetSockName(Void);

[ public ]
SFCError IOCtl(
    SInt32 option   // the option id 
    UInt32 value    // the option value 
);

[ public ]
SFCError Listen(
    SInt32 maxPending   // the maximum number of pending connections
);

[ public ]
SInt32 ReadV(
    SockIOBlock* ioblocks   // array of SockIOBlock structures into which data can be read
    UInt16 count            // specifies the number of entries in the iov array
);

[ public ]
SFCError Realize(Void);

[ public ]
SInt32 RecvFrom(
    VoidPtr buff   // buffer to hold the received data
    UInt16 bytes   // size of the buffer, in terms of number of bytes
    UInt16 flags   // unused, must be set to 0
    INAddr* addr   // pointer to the IP Address in network byte order
    INPort* port   // pointer to the port in network byte order
);

[ public ]
SInt32 RecvFrom(
    SFXBufferPtr buff   // buffer to hold the received data, 
                        // the size is converted into UInt16 when called by API
    UInt16 flags        // unused, must be set to 0
    INAddr* addr        // pointer to the IP Address in network byte order
    INPort* port        // pointer to the port in network byte order
);

[ public ]
SInt32 RecvFrom(
    VoidPtr buff                 // buffer to hold the received data
    UInt16 bytes                 // size of the buffer, in terms of number of bytes
    UInt16 flags                 // unused, must be set to 0
    SFXSocketAddressPtr sender   // the IP Address and Port of the sender
);

[ public ]
SInt32 RecvFrom(
    SFXBufferPtr buff            // buffer to hold the received data, 
                                 // the size is converted into UInt16 when called by API
    UInt16 flags                 // unused, must be set to 0
    SFXSocketAddressPtr sender   // the IP Address and Port of the sender
);

[ public ]
SInt32 SendTo(
    VoidPtr buff   // buffer containing data to be sent
    UInt16 bytes   // size of the buffer, in terms of number of bytes
    UInt16 flags   // unused, must be set to 0
    INAddr addr    // IP Address
    INPort port    // port
);

[ public ]
SInt32 SendTo(
    SFXBufferPtr buff   // buffer containing data to be sent. 3
                        // if null, do nothing and return AEE_NET_ERROR
    UInt16 flags        // unused, must be set to 0
    INAddr addr         // IP Address
    INPort port         // port
);

[ public ]
SInt32 SendTo(
    VoidPtr buff                    // buffer containing data to be sent
    UInt16 bytes                    // size of the buffer, in terms of number of bytes
    UInt16 flags                    // unused, must be set to 0
    SFXSocketAddressConstRef dest   // IP Address and Port of the destination
);

[ public ]
SInt32 SendTo(
    SFXBufferPtr buff               // buffer containing data to be sent. 
                                    // if null, do nothing and return AEE_NET_ERROR
    UInt16 flags                    // unused, must be set to 0
    SFXSocketAddressConstRef dest   // IP Address and Port of the destination
);

[ public ]
SFCError SetOpt(
    SInt32 level     // option level (see AEESockOpt) 
    SInt32 optName   // option name (see AEESockOpt)  
    VoidPtr optVal   // pointer to the data type appropriate for the option
    SInt32 optSize   // size of optVal
);

[ public ]
SFCError SetOpt(
    SInt32 level            // option level (see AEESockOpt) 
    SInt32 optName          // option name (see AEESockOpt)  
    SFXBufferConstRef opt   // pointer to the data type appropriate for the option
);

[ public ]
SFCError Shutdown(
    SInt32 how   // dictates which portion(s) of the connection to shutdown 
);

[ public ]
SInt32 Write(
    VoidPtr buff   // pointer to the buffer from which the data is sent
    UInt32 bytes   // specifies the size of the buffer in terms of number of bytes in the buffer.
                   // in BREW 2.0 it is of UInt16
);

[ public ]
SInt32 Write(
    SFXBufferPtr buff   // buffer
                        // if null, do nothing and return AEE_NET_ERROR
);

[ public ]
SInt32 WriteV(
    SockIOBlock* ioblocks   // an array of SockIOBlocks containing the individual buffers to be sent
    UInt16 count            // number of entries inside the SockIOBlock structure
);

[ public ]
Void Writeable(
    PFNNOTIFY notify      // address of the callback function. 
                          // this function is invoked by AEE when the socket becomes ready 
                          // to receive data or when it is ready to be closed. 
                          // if this is null, it cancels the Writeable callback function 
                          // registered by a previous call to SFBSOCKET::Writeable()
    VoidPtr data = null   // user-defined data that is passed to the callback function when it is invoked
);