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_MEMBER_HPP 00008 #define COH_MEMBER_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 COH_OPEN_NAMESPACE2(coherence,net) 00013 00014 00015 /** 00016 * The Member interface represents a cluster member. 00017 * 00018 * @author jh 2007.12.20 00019 */ 00020 class COH_EXPORT Member 00021 : public interface_spec<Member> 00022 { 00023 // ----- Member interface ----------------------------------------------- 00024 00025 public: 00026 /** 00027 * Return the name of the cluster with which this member is associated. 00028 * 00029 * @return the cluster name 00030 * 00031 * @since Coherence 12.2.1 00032 */ 00033 virtual String::View getClusterName() const = 0; 00034 00035 /** 00036 * Determine the configured name for the Site (such as a data center) 00037 * in which this Member resides. This name is used for logging 00038 * purposes and to differentiate among multiple geographic sites. 00039 * 00040 * @return the configured Site name or null 00041 */ 00042 virtual String::View getSiteName() const = 0; 00043 00044 /** 00045 * Determine the configured name for the Rack (such as a physical 00046 * rack, cage or blade frame) in which this Member resides. This name 00047 * is used for logging purposes and to differentiate among multiple 00048 * racks within a particular data center, for example. 00049 * 00050 * @return the configured Rack name or null 00051 */ 00052 virtual String::View getRackName() const = 0; 00053 00054 /** 00055 * Determine the configured name for the Machine (such as a host name) 00056 * in which this Member resides. This name is used for logging 00057 * purposes and to differentiate among multiple servers. 00058 * 00059 * @return the configured Machine name or null 00060 */ 00061 virtual String::View getMachineName() const = 0; 00062 00063 /** 00064 * Determine the configured name for the Process (such as a JVM) in 00065 * which this Member resides. This name is used for logging purposes 00066 * and to differentiate among multiple processes on a a single 00067 * machine. 00068 * 00069 * @return the configured Process name or null 00070 */ 00071 virtual String::View getProcessName() const = 0; 00072 00073 /** 00074 * Determine the configured name for the Member. This name is used for 00075 * logging purposes and to differentiate among Members running within 00076 * a particular process. 00077 * 00078 * @return the configured Member name or null 00079 */ 00080 virtual String::View getMemberName() const = 0; 00081 00082 /** 00083 * Determine the configured role name for the Member. This role is 00084 * completely definable by the application, and can be used to 00085 * determine what Members to use for specific purposes, such as to 00086 * send particular types of work to. 00087 * 00088 * @return the configured role name for the Member or null 00089 */ 00090 virtual String::View getRoleName() const = 0; 00091 }; 00092 00093 COH_CLOSE_NAMESPACE2 00094 00095 #endif // COH_MEMBER_HPP