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_NET_SERVICE_HPP 00008 #define COH_NET_SERVICE_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 #include "coherence/io/Serializer.hpp" 00013 #include "coherence/net/MemberListener.hpp" 00014 #include "coherence/net/ServiceInfo.hpp" 00015 #include "coherence/util/Service.hpp" 00016 00017 COH_OPEN_NAMESPACE2(coherence,net) 00018 00019 using coherence::io::Serializer; 00020 00021 00022 /** 00023 * This Service interface represents a controllable service that operates in a 00024 * clustered network environment. 00025 * 00026 * @author jh 2007.12.20 00027 */ 00028 class COH_EXPORT Service 00029 : public interface_spec<Service, 00030 implements<coherence::util::Service> > 00031 { 00032 // ----- Service interface ---------------------------------------------- 00033 00034 public: 00035 /** 00036 * Return the ServiceInfo object for this Service. 00037 * 00038 * @return the ServiceInfo object 00039 */ 00040 virtual ServiceInfo::View getInfo() const = 0; 00041 00042 /** 00043 * Add a Member listener. 00044 * <p/> 00045 * MemberListeners will be invoked in the order in which they are registered. 00046 * 00047 * @param hListener the {@link MemberListener} to add 00048 */ 00049 virtual void addMemberListener(MemberListener::Handle hListener) = 0; 00050 00051 /** 00052 * Remove a Member listener. 00053 * 00054 * @param hListener the {@link MemberListener} to remove 00055 */ 00056 virtual void removeMemberListener(MemberListener::Handle hListener) = 0; 00057 00058 /** 00059 * Return the user context object associated with this Service. 00060 * 00061 * The data type and semantics of this context object are entirely 00062 * application specific and are opaque to the Service itself. 00063 * 00064 * @return an associated user context object or NULL if a context 00065 * has not been set 00066 */ 00067 virtual Object::Holder getUserContext() const = 0; 00068 00069 /** 00070 * Associate a user context object with this Service. 00071 * 00072 * @param ohCtx a user context object 00073 */ 00074 virtual void setUserContext(Object::Holder ohCtx) = 0; 00075 00076 /** 00077 * Return a Serializer used by this Service. 00078 * 00079 * @return the Serializer object 00080 * 00081 * @since Coherence 3.4 00082 */ 00083 virtual Serializer::View getSerializer() const = 0; 00084 00085 /** 00086 * Specifies the ThreadGroup within which the Service thread will be 00087 * created. If not specified, the current Thread's ThreadGroup will be 00088 * used. 00089 * 00090 * This property can only be set at runtime, and must be configured 00091 * before start() is invoked to cause the Service thread to be created 00092 * within the specified ThreadGroup. 00093 * 00094 * @param hGroup the group to use 00095 */ 00096 virtual void setThreadGroup(ThreadGroup::Handle hGroup) = 0; 00097 00098 /** 00099 * Return the ThreadGroup for the Daemon. 00100 * 00101 * @return the ThreadGroup for the Daemon. 00102 */ 00103 virtual ThreadGroup::Handle getThreadGroup() = 0; 00104 00105 /** 00106 * Return the ThreadGroup for the Daemon. 00107 * 00108 * @return the ThreadGroup for the Daemon. 00109 */ 00110 virtual ThreadGroup::View getThreadGroup() const = 0; 00111 }; 00112 00113 COH_CLOSE_NAMESPACE2 00114 00115 #endif // COH_NET_SERVICE_HPP