C++ Client API Reference for Oracle Coherence: coherence/net/AbstractInvocable.hpp Source File

00001 /*
00002  * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * http://oss.oracle.com/licenses/upl.
00006  */
00007 #ifndef COH_ABSTRACT_INVOCABLE_HPP
00008 #define COH_ABSTRACT_INVOCABLE_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/net/Invocable.hpp"
00013 #include "coherence/net/InvocationService.hpp"
00014 #include "coherence/net/PriorityTask.hpp"
00015 
00016 COH_OPEN_NAMESPACE2(coherence,net)
00017 
00018 /**
00019  * An abstract base for Invocable and PriorityTask implementations.
00020  *
00021  * For Invocables which only run within the Coherence cluster (most common case),
00022  * the C++ init, getResult and run methods can be left unimplemented.
00023  *
00024  * @author mf 2008.08.26
00025  */
00026 class COH_EXPORT AbstractInvocable
00027     : public abstract_spec<AbstractInvocable,
00028         extends<Object>,
00029         implements<Invocable, PriorityTask> >
00030     {
00031     // ----- Invocable interface --------------------------------------------
00032 
00033     public:
00034         /**
00035          * {@inheritDoc}
00036          *
00037          * This implementation throws an UnsupportedOperationException.
00038          */
00039         virtual void init(InvocationService::Handle hService);
00040 
00041         /**
00042          * {@inheritDoc}
00043          *
00044          * This implementation throws an UnsupportedOperationException.
00045          */
00046         virtual Object::Holder getResult() const;
00047 
00048         /**
00049          * {@inheritDoc}
00050          *
00051          * This implementation throws an UnsupportedOperationException.
00052          */
00053         virtual void run();
00054 
00055     // ----- PriorityTask interface -----------------------------------------
00056 
00057     public:
00058         /**
00059          * {@inheritDoc}
00060          *
00061          * This implementation returns schedule_standard.
00062          */
00063         virtual int32_t getSchedulingPriority() const;
00064 
00065         /**
00066          * {@inheritDoc}
00067          *
00068          * This implementation returns timeout_default.
00069          */
00070         virtual int64_t getExecutionTimeoutMillis() const;
00071 
00072         /**
00073          * {@inheritDoc}
00074          *
00075          * This implementation is a no-op.
00076          */
00077         virtual void runCanceled(bool fAbandoned);
00078 
00079         /**
00080          * {@inheritDoc}
00081          *
00082          * This implementation returns timeout_default.
00083          */
00084         virtual int64_t getRequestTimeoutMillis() const;
00085     };
00086 
00087 COH_CLOSE_NAMESPACE2
00088 
00089 #endif // COH_ABSTRACT_INVOCABLE_HPP