OmmProvider.h

Go to the documentation of this file.

/*|-----------------------------------------------------------------------------
 *|            This source code is provided under the Apache 2.0 license      --
 *|  and is provided AS IS with no warranty or guarantee of fit for purpose.  --
 *|                See the project's LICENSE.md for details.                  --
 *|           Copyright (C) 2020 Refinitiv. All rights reserved.            --
 *|-----------------------------------------------------------------------------
 */

#ifndef __thomsonreuters_ema_access_OmmProvider_h
#define __thomsonreuters_ema_access_OmmProvider_h

#include "Access/Include/Common.h"
#include "Access/Include/OmmProviderConfig.h"
#include "Access/Include/ChannelInformation.h"
#include "Access/Include/ChannelStatistics.h"
#include "Access/Include/EmaVector.h"

namespace thomsonreuters {

namespace ema {

namespace access {

class OmmProviderClient;
class OmmProviderConfig;
class OmmProviderClient;
class OmmProviderErrorClient;
class OmmProviderImpl;
class EmaString;
class AckMsg;
class GenericMsg;
class RefreshMsg;
class ReqMsg;
class StatusMsg;
class UpdateMsg;
class ChannelInformation;

class EMA_ACCESS_API OmmProvider
{
public :

    enum DispatchTimeout
    {
        InfiniteWaitEnum = -1,      
        NoWaitEnum = 0              
    };

    enum DispatchReturn
    {
        TimeoutEnum = -1,       
        DispatchedEnum = 0      
    };



    OmmProvider( const OmmProviderConfig& config );

    OmmProvider( const OmmProviderConfig& config, OmmProviderClient& client, void* closure = 0 );

    OmmProvider( const OmmProviderConfig& config, OmmProviderErrorClient& errorclient );

    OmmProvider( const OmmProviderConfig& config, OmmProviderClient& client, OmmProviderErrorClient& errorclient, void* closure = 0 );




    virtual ~OmmProvider();



    const EmaString& getProviderName() const;

    OmmProviderConfig::ProviderRole getProviderRole() const;



    UInt64 registerClient( const ReqMsg& reqMsg, OmmProviderClient& client, void* closure = 0 );

    void reissue( const ReqMsg& reqMsg, UInt64 handle );

    void submit( const GenericMsg& genericMsg, UInt64 handle );

    void submit( const RefreshMsg& refreshMsg, UInt64 handle );

    void submit( const UpdateMsg& updateMsg, UInt64 handle );
    
    void submit( const StatusMsg& statusMsg, UInt64 handle );

    Int64 dispatch( Int64 timeOut = NoWaitEnum );

    void unregister( UInt64 handle );

    // IProv

    void submit( const AckMsg& ackMsg, UInt64 handle );

    void getConnectedClientChannelInfo(EmaVector<ChannelInformation> &);

    void getConnectedClientChannelStats(UInt64 clientHandle, ChannelStatistics & cs);

    void getChannelInformation(ChannelInformation&);

    void modifyIOCtl( Int32 code, Int32 value, UInt64 handle = 0 );

    void closeChannel( UInt64 clientHandle );

private :

    OmmProviderImpl*    _pImpl;
    OmmProviderConfig::ProviderRole _role;

    OmmProvider( const OmmProvider& );
    OmmProvider& operator=( const OmmProvider& );
};

}

}

}

#endif // __thomsonreuters_ema_access_OmmProvider_h