Handler.h

Go to the documentation of this file.

#pragma once
/*
* Copyright Onix Solutions Limited [OnixS]. All rights reserved.
*
* This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
* and international copyright treaties.
*
* Access to and use of the software is governed by the terms of the applicable ONIXS Software
* Services Agreement (the Agreement) and Customer end user license agreements granting
* a non-assignable, non-transferable and non-exclusive license to use the software
* for it's own data processing purposes under the terms defined in the Agreement.
*
* Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
* of this source code or associated reference material to any other location for further reproduction
* or redistribution, and any amendments to this copyright notice, are expressly prohibited.
*
* Any reproduction or redistribution for sale or hiring of the Software not in accordance with
* the terms of the Agreement is a violation of copyright law.
*/
 
#include "OnixS/MTS/Cash/SDP/ABI.h"
#include "OnixS/MTS/Cash/SDP/ActResultListener.h"
#include "OnixS/MTS/Cash/SDP/AdminMessageListener.h"
#include "OnixS/MTS/Cash/SDP/ErrorListener.h"
#include "OnixS/MTS/Cash/SDP/Enumerations.h"
#include "OnixS/MTS/Cash/SDP/HandlerSettings.h"
#include "OnixS/MTS/Cash/SDP/HandlerStateListener.h"
#include "OnixS/MTS/Cash/SDP/ServiceAddressInformationListener.h"
#include "OnixS/MTS/Cash/SDP/SessionListener.h"
#include "OnixS/MTS/Cash/SDP/SMP.ClassIds.h"
#include "OnixS/MTS/Cash/SDP/SMP.ClassListener.h"
#include "OnixS/MTS/Cash/SDP/SubscriptionListener.h"
#include "OnixS/MTS/Cash/SDP/WarningListener.h"
 
#include <cstddef>
#include <string>
 
namespace OnixS {
namespace Mts {
namespace Cash {
namespace SDP {
 
class Class;
struct ReplayOptions;
 
template <typename TResultEnum>
struct FilterResponse
{
    TResultEnum result;

    UInt32 filterKey;
};

using CreateFilterResponse = FilterResponse<CreateFilterResult::Enum>;

using SetFilterResponse = FilterResponse<SetFilterResult::Enum>;

using DestroyFilterResponse = FilterResponse<DestroyFilterResult::Enum>;

class ONIXS_MTS_CASH_SDP_API Handler
{
public:
    Handler (const HandlerSettings& settings);
 
    virtual ~Handler();

    void connect (const ConnectionSettings& connectionSettings, const LogonSettings& logonSettings, const std::string& hostName, UInt16 port, const std::string& localNetworkInterface = "");

    void disconnect ();

    void disconnectAsync ();

    void replay(const ReplayOptions& options);

    void requestAddressServiceInformation ();

    void subscribe(ClassId::Enum classId, SubscribeType::Enum subscribeType = SubscribeType::All);

    void subscribeFiltered(ClassId::Enum classId, UInt32 filterKey, SubscribeType::Enum subscribeType = SubscribeType::All);

    void unsubscribe(ClassId::Enum classId);

    UInt32 act(ActionType::Enum actionType, Class* msg, bool dataInResponse = false);

    UInt32 addFilter(UInt32 filterId, const std::string& value);

    CreateFilterResponse createFilter(FilterId::Enum filterId, const std::string& value);

    SetFilterResponse setFilter(UInt32 filterKey, const std::string& value);

    DestroyFilterResponse destroyFilter(UInt32 filterKey);

    void registerErrorListener (ErrorListener* listener);

    void registerWarningListener (WarningListener* listener);

    void registerHandlerStateListener (HandlerStateListener* listener);

    void registerSessionListener (SessionListener* listener);

    void registerServiceAddressInformationListener (ServiceAddressInformationListener* listener);

    void registerAdminMessageListener (AdminMessageListener* listener);

    void registerClassListener (ClassListener* listener);

    void registerActResultListener(ActResultListener* listener);

    void registerSubscriptionListener(SubscriptionListener* listener);

    HandlerState::Enum state () const;

    Handler& log (LogLevel::Enum logLevel, const char* logMessage, size_t length);

    Handler& log (LogLevel::Enum logLevel, const char* logMessage);

    Handler& log (LogLevel::Enum logLevel, const std::string& str);

    const std::string& licenseExpirationDate () const;

    static const std::string version ();
 
private:
    Handler (const Handler&); // no implementation
    Handler& operator = (const Handler&); // no implementation
 
private:
    struct Impl;
    Impl* impl_;
};
}
}
}
}