fbio.h

Go to the documentation of this file.

#ifndef __FBIO_H__
#define __FBIO_H__
/**************************************************************************
 Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.
 
 The coded instructions, statements, computer programs, and/or related 
 material (collectively the "Data") in these files contain unpublished 
 information proprietary to Autodesk, Inc. and/or its licensors, which is 
 protected by Canada and United States of America federal copyright law 
 and by international treaties.
 
 The Data may not be disclosed or distributed to third parties, in whole 
 or in part, without the prior written consent of Autodesk, Inc. 
 ("Autodesk").
 
 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
 ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
 OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
 PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
 WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
 FREE.
 
 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
 EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
 DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
 OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
 DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
 LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
 LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
 DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
 BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
 
**************************************************************************/

#include <kaydaradef.h>
#ifndef FBSDK_DLL 

    #define FBSDK_DLL K_DLLIMPORT
#endif

#include <fbsdk/fbcomponent.h>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

// FBCommPort
#define FBCOMMPORT_DEFAULT_BLOCKING_TIMEOUT 500  // Millisecs

enum FBParity   { 
    kFBParityNone,  
    kFBParityOdd,   
    kFBParityEven   
};

enum FBRSType {
    kFBRS232,       
    kFBRS422        
};
enum FBCommPortType { 
    kFBPhysical,    
    kFBVirtual,     
    kFBInternal     
};


FB_DEFINE_ENUM      ( FBSDK_DLL, Parity     );
FB_DEFINE_ENUM      ( FBSDK_DLL, RSType     );
FB_DEFINE_ENUM      ( FBSDK_DLL, CommPortType   );
FB_DEFINE_COMPONENT ( FBSDK_DLL, CommPort   );

__FB_FORWARD( FBCommPort );

class FBSDK_DLL FBCommPort : public FBComponent {
    __FBClassDeclare( FBCommPort,FBComponent );
public:

    FBCommPort();

    bool Read( void* lpBuffer, int nNumberOfBytesToRead, int* lpNumberOfBytesRead=NULL );

    bool ReadBlocking( void* lpBuffer, int nNumberOfBytesToRead, int* lpNumberOfBytesRead=NULL, kULong pTimeOut = FBCOMMPORT_DEFAULT_BLOCKING_TIMEOUT);

    bool Write( void* lpBuffer, int nNumberOfBytesToWrite, int *lpNumberOfBytesWritten=NULL );

    bool WriteBlocking( void* lpBuffer, int nNumberOfBytesToWrite, int* lpNumberOfBytesWritten=NULL, kULong pTimeOut = FBCOMMPORT_DEFAULT_BLOCKING_TIMEOUT);

    bool EmptyBuffer();

    FBPropertyInt       PortNumber;         
    FBPropertyString    OwnerName;          
    FBPropertyInt       BaudRate;           
    FBPropertyBool      UseHardwareFC;      

    FBPropertyParity    Parity;             
    FBPropertyInt       ByteSize;           
    FBPropertyInt       StopBits;           
    FBPropertyRSType    RSType;             
    FBPropertyCommPortType  CommPortType;       

    FBPropertyBool      Active;             
};

// Property list Comm Port
__FB_FORWARD( FBPropertyListCommPort );
typedef class FBSDK_DLL FBPropertyBaseList< int > FBPropertyBaseListInt;

class FBSDK_DLL FBPropertyListCommPort : public FBPropertyBaseList< int >
{
public:
    virtual int  Add    ( int pItem );
    virtual int  Remove ( int pItem );
    virtual void RemoveAt( int pIndex );
    virtual int operator[](int pIndex);
    virtual int  GetCount();
};

// FBTCPIP
#define FBTCPIP_DEFAULT_BLOCKING_TIMEOUT 500  // Millisecs

enum FBTCPIPSocketType { 
    kFBTCPIP_Stream,    
    kFBTCPIP_DGRAM,     
    kFBTCPIP_RAW        
};

__FB_FORWARD( FBTCPIP );

class FBSDK_DLL FBTCPIP : public FBComponent {
    __FBClassDeclare( FBTCPIP,FBComponent );
public:
    FBTCPIP();

    bool Read( int pSocket, void* lpBuffer, int nNumberOfBytesToRead, int* lpNumberOfBytesRead=NULL );

    bool ReadBlocking( int pSocket, void* lpBuffer, int nNumberOfBytesToRead, int* lpNumberOfBytesRead=NULL, kULong pTimeOut = FBTCPIP_DEFAULT_BLOCKING_TIMEOUT );

    bool ReadDatagram( int pSocket, void* lpBuffer, int nNumberOfBytesToRead, int* lpNumberOfBytesRead=NULL, kULong* pAddr=NULL, unsigned short *pPort=NULL );

    bool Write( int pSocket, void* lpBuffer, int nNumberOfBytesToWrite, int* lpNumberOfBytesWritten=NULL );

    bool WriteBlocking( int pSocket, void* lpBuffer, int nNumberOfBytesToWrite, int* lpNumberOfBytesToWrite=NULL, kULong pTimeOut = FBTCPIP_DEFAULT_BLOCKING_TIMEOUT );

    bool WriteDatagram( int pSocket, void* lpBuffer, int nNumberOfBytesToWrite, int* lpNumberOfBytesToWrite, kULong pAddr, unsigned short pPort );

    bool CreateSocket( int &pSocket, FBTCPIPSocketType pType, const char *pProtocol = "ip", bool pNonBlocking=true );

    bool Bind( int &pSocket, kULong pAddr /*=INADDR_ANY*/, int pPort=0 );

    bool Connect( int &pSocket, char *pAddr, int pPort );

    bool CloseSocket( int &pSocket );

    int  Listen( int pSocket, int pBackLog=1 );

    int  Accept( int pSocket, kULong *pOutAddr=NULL );

    int  Select( int pSocket, bool pTestRead, bool pTestWrite, bool pTestError, kULong pTimeOutMilisecond=0 );
};

#ifdef FBSDKUseNamespace
    }
#endif


#endif