soss_events.h

/*
 Copyright (c) 2013 by ScaleOut Software, Inc.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
*/ 

#pragma once

#include <stdint.h>
#include <boost/function.hpp>

#include "soss_client/soss_key.h"
#include "soss_client/named_cache.h"
#include "soss_svccli.h"

namespace sosscli {

class SossEvents
{
public:

 enum EventCode
 {
 ObjectTimeout = SOSSLIB_EVT_TIMEOUT,

 LowMemory = SOSSLIB_EVT_LOW_MEM,

 Dependency = SOSSLIB_EVT_DEPEND,

 LoadFromBackingStore = SOSSLIB_EVT_LOAD,

 StoreInBackingStore = SOSSLIB_EVT_STORE,

 EraseFromBackingStore = SOSSLIB_EVT_ERASE,
 };

 enum ObjectDisposition
 {
 Save = SOSSLIB_EVTRET_SAVE,

 Remove = SOSSLIB_EVTRET_REMOVE,

 NotHandled = SOSSLIB_EVTRET_NOT_HANDLED,
 };

 class EventDetails {
 public:
 EventDetails(SossKey key, EventCode event_code);

 SossKey key() const { return key_; }

 EventCode event_code() const { return event_code_; }

 private:
 SossKey key_;
 EventCode event_code_;
 };

 typedef boost::function<ObjectDisposition(EventDetails const & details)> Callback;

 typedef uint32_t CallbackHandle;

 static CallbackHandle register_callback(NamedCache const & cache, Callback const & callback);

 static CallbackHandle register_callback(uint32_t app_id, Callback const & callback);

 static void clear_callbacks(NamedCache const & cache);

 static void clear_callbacks(uint32_t app_id);

 static void erase_callback(NamedCache const & cache, CallbackHandle callback_handle);

 static void erase_callback(uint32_t app_id, CallbackHandle callback_handle);

private:
 class Impl;
 static Impl * impl_p_;
};

}