http://git-wip-us.apache.org/repos/asf/geode/blob/fc9f1f6f/src/clicache/src/ISubscriptionService.hpp ---------------------------------------------------------------------- diff --git a/src/clicache/src/ISubscriptionService.hpp b/src/clicache/src/ISubscriptionService.hpp index 79acb4b..36e7ad7 100644 --- a/src/clicache/src/ISubscriptionService.hpp +++ b/src/clicache/src/ISubscriptionService.hpp @@ -30,594 +30,594 @@ namespace Apache generic<class TKey> /// <summary> /// This generic interface class provides all Register Interest API's for - /// gemfire's generic non local region (Region<TKey, TValue>). + /// geode's generic non local region (Region<TKey, TValue>). /// Region<TKey, TValue> class implements all methods of this interface class. /// LocalRegion<TKey, TValue> class does not implement this interface class. /// </summary> public interface class ISubscriptionService { - public: + public: - /// <summary> - /// Registers a collection of keys for getting updates from the server. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// </summary> - /// <param name="keys">a collection of keys</param> - /// <exception cref="IllegalArgumentException"> - /// If the collection of keys is empty. - /// </exception> - /// <exception cref="IllegalStateException"> - /// If already registered interest for all keys. - /// </exception> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// For pools configured with locators, if no locators are available, innerException - /// of NotConnectedException is set to NoAvailableLocatorsException. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void RegisterKeys( System::Collections::Generic::ICollection<TKey>^ keys ); + /// <summary> + /// Registers a collection of keys for getting updates from the server. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// </summary> + /// <param name="keys">a collection of keys</param> + /// <exception cref="IllegalArgumentException"> + /// If the collection of keys is empty. + /// </exception> + /// <exception cref="IllegalStateException"> + /// If already registered interest for all keys. + /// </exception> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// For pools configured with locators, if no locators are available, innerException + /// of NotConnectedException is set to NoAvailableLocatorsException. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void RegisterKeys(System::Collections::Generic::ICollection<TKey>^ keys); - /// <summary> - /// Registers a collection of keys for getting updates from the server. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// Should only be called for durable clients and with cache server version 5.5 onwards. - /// </summary> - /// <param name="keys">a collection of keys</param> - /// <param name="isDurable">whether the registration should be durable</param> - /// <param name="getInitialValues"> - /// true to populate the cache with values of the keys - /// that were registered on the server - /// </param> - /// <exception cref="IllegalArgumentException"> - /// If the collection of keys is empty. - /// </exception> - /// <exception cref="IllegalStateException"> - /// If already registered interest for all keys. - /// </exception> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// For pools configured with locators, if no locators are available, innerException - /// of NotConnectedException is set to NoAvailableLocatorsException. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void RegisterKeys(System::Collections::Generic::ICollection<TKey>^ keys, bool isDurable, bool getInitialValues); + /// <summary> + /// Registers a collection of keys for getting updates from the server. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// Should only be called for durable clients and with cache server version 5.5 onwards. + /// </summary> + /// <param name="keys">a collection of keys</param> + /// <param name="isDurable">whether the registration should be durable</param> + /// <param name="getInitialValues"> + /// true to populate the cache with values of the keys + /// that were registered on the server + /// </param> + /// <exception cref="IllegalArgumentException"> + /// If the collection of keys is empty. + /// </exception> + /// <exception cref="IllegalStateException"> + /// If already registered interest for all keys. + /// </exception> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// For pools configured with locators, if no locators are available, innerException + /// of NotConnectedException is set to NoAvailableLocatorsException. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void RegisterKeys(System::Collections::Generic::ICollection<TKey>^ keys, bool isDurable, bool getInitialValues); - /// <summary> - /// Registers a collection of keys for getting updates from the server. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// Should only be called for durable clients and with cache server version 5.5 onwards. - /// </summary> - /// <param name="keys">a collection of keys</param> - /// <param name="isDurable">whether the registration should be durable</param> - /// <param name="getInitialValues"> - /// true to populate the cache with values of the keys - /// that were registered on the server - /// </param> - /// <param name="receiveValues"> - /// whether to act like notify-by-subscription is true - /// </param> - /// <exception cref="IllegalArgumentException"> - /// If the collection of keys is empty. - /// </exception> - /// <exception cref="IllegalStateException"> - /// If already registered interest for all keys. - /// </exception> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void RegisterKeys(System::Collections::Generic::ICollection<TKey>^ keys, bool isDurable, bool getInitialValues, bool receiveValues); + /// <summary> + /// Registers a collection of keys for getting updates from the server. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// Should only be called for durable clients and with cache server version 5.5 onwards. + /// </summary> + /// <param name="keys">a collection of keys</param> + /// <param name="isDurable">whether the registration should be durable</param> + /// <param name="getInitialValues"> + /// true to populate the cache with values of the keys + /// that were registered on the server + /// </param> + /// <param name="receiveValues"> + /// whether to act like notify-by-subscription is true + /// </param> + /// <exception cref="IllegalArgumentException"> + /// If the collection of keys is empty. + /// </exception> + /// <exception cref="IllegalStateException"> + /// If already registered interest for all keys. + /// </exception> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void RegisterKeys(System::Collections::Generic::ICollection<TKey>^ keys, bool isDurable, bool getInitialValues, bool receiveValues); - /// <summary> - /// Unregisters a collection of keys to stop getting updates for them. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// </summary> - /// <param name="keys">the collection of keys</param> - /// <exception cref="IllegalArgumentException"> - /// If the collection of keys is empty. - /// </exception> - /// <exception cref="IllegalStateException"> - /// If no keys were previously registered. - /// </exception> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// For pools configured with locators, if no locators are available, innerException - /// of NotConnectedException is set to NoAvailableLocatorsException. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void UnregisterKeys(System::Collections::Generic::ICollection<TKey>^ keys); + /// <summary> + /// Unregisters a collection of keys to stop getting updates for them. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// </summary> + /// <param name="keys">the collection of keys</param> + /// <exception cref="IllegalArgumentException"> + /// If the collection of keys is empty. + /// </exception> + /// <exception cref="IllegalStateException"> + /// If no keys were previously registered. + /// </exception> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// For pools configured with locators, if no locators are available, innerException + /// of NotConnectedException is set to NoAvailableLocatorsException. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void UnregisterKeys(System::Collections::Generic::ICollection<TKey>^ keys); - /// <summary> - /// Register interest for all the keys of the region to get - /// updates from the server. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// </summary> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// For pools configured with locators, if no locators are available, innerException - /// of NotConnectedException is set to NoAvailableLocatorsException. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void RegisterAllKeys( ); + /// <summary> + /// Register interest for all the keys of the region to get + /// updates from the server. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// </summary> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// For pools configured with locators, if no locators are available, innerException + /// of NotConnectedException is set to NoAvailableLocatorsException. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void RegisterAllKeys(); - /// <summary> - /// Register interest for all the keys of the region to get - /// updates from the server. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// Should only be called for durable clients and with cache server version 5.5 onwards. - /// </summary> - /// <param name="isDurable">whether the registration should be durable</param> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// For pools configured with locators, if no locators are available, innerException - /// of NotConnectedException is set to NoAvailableLocatorsException. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void RegisterAllKeys( bool isDurable ); + /// <summary> + /// Register interest for all the keys of the region to get + /// updates from the server. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// Should only be called for durable clients and with cache server version 5.5 onwards. + /// </summary> + /// <param name="isDurable">whether the registration should be durable</param> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// For pools configured with locators, if no locators are available, innerException + /// of NotConnectedException is set to NoAvailableLocatorsException. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void RegisterAllKeys(bool isDurable); - /// <summary> - /// Register interest for all the keys of the region to get - /// updates from the server. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// Should only be called for durable clients and with cache server version 5.5 onwards. - /// </summary> - /// <param name="isDurable">whether the registration should be durable</param> - /// <param name="resultKeys"> - /// if non-null then all keys on the server are returned - /// </param> - /// <param name="getInitialValues"> - /// true to populate the cache with values of all the keys - /// from the server - /// </param> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// For pools configured with locators, if no locators are available, innerException - /// of NotConnectedException is set to NoAvailableLocatorsException. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void RegisterAllKeys(bool isDurable, - System::Collections::Generic::ICollection<TKey>^ resultKeys, - bool getInitialValues); + /// <summary> + /// Register interest for all the keys of the region to get + /// updates from the server. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// Should only be called for durable clients and with cache server version 5.5 onwards. + /// </summary> + /// <param name="isDurable">whether the registration should be durable</param> + /// <param name="resultKeys"> + /// if non-null then all keys on the server are returned + /// </param> + /// <param name="getInitialValues"> + /// true to populate the cache with values of all the keys + /// from the server + /// </param> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// For pools configured with locators, if no locators are available, innerException + /// of NotConnectedException is set to NoAvailableLocatorsException. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void RegisterAllKeys(bool isDurable, + System::Collections::Generic::ICollection<TKey>^ resultKeys, + bool getInitialValues); - /// <summary> - /// Register interest for all the keys of the region to get - /// updates from the server. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// Should only be called for durable clients and with cache server version 5.5 onwards. - /// </summary> - /// <param name="isDurable">whether the registration should be durable</param> - /// <param name="resultKeys"> - /// if non-null then all keys on the server are returned - /// </param> - /// <param name="getInitialValues"> - /// true to populate the cache with values of all the keys - /// from the server - /// </param> - /// <param name="receiveValues"> - /// whether to act like notify-by-subscription is true - /// </param> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void RegisterAllKeys(bool isDurable, - System::Collections::Generic::ICollection<TKey>^ resultKeys, - bool getInitialValues, - bool receiveValues); + /// <summary> + /// Register interest for all the keys of the region to get + /// updates from the server. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// Should only be called for durable clients and with cache server version 5.5 onwards. + /// </summary> + /// <param name="isDurable">whether the registration should be durable</param> + /// <param name="resultKeys"> + /// if non-null then all keys on the server are returned + /// </param> + /// <param name="getInitialValues"> + /// true to populate the cache with values of all the keys + /// from the server + /// </param> + /// <param name="receiveValues"> + /// whether to act like notify-by-subscription is true + /// </param> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void RegisterAllKeys(bool isDurable, + System::Collections::Generic::ICollection<TKey>^ resultKeys, + bool getInitialValues, + bool receiveValues); - /// <summary> - /// get the interest list on this client - /// </summary> - System::Collections::Generic::ICollection<TKey>^ GetInterestList(); + /// <summary> + /// get the interest list on this client + /// </summary> + System::Collections::Generic::ICollection<TKey>^ GetInterestList(); - /// <summary> - /// get the list of interest regular expressions on this client - /// </summary> - System::Collections::Generic::ICollection<String^>^ GetInterestListRegex(); + /// <summary> + /// get the list of interest regular expressions on this client + /// </summary> + System::Collections::Generic::ICollection<String^>^ GetInterestListRegex(); - /// <summary> - /// Unregister interest for all the keys of the region to stop - /// getting updates for them. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// </summary> - /// <exception cref="IllegalStateException"> - /// If not previously registered all keys. - /// </exception> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// For pools configured with locators, if no locators are available, innerException - /// of NotConnectedException is set to NoAvailableLocatorsException. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void UnregisterAllKeys( ); + /// <summary> + /// Unregister interest for all the keys of the region to stop + /// getting updates for them. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// </summary> + /// <exception cref="IllegalStateException"> + /// If not previously registered all keys. + /// </exception> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// For pools configured with locators, if no locators are available, innerException + /// of NotConnectedException is set to NoAvailableLocatorsException. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void UnregisterAllKeys(); - /// <summary> - /// Register interest for the keys of the region that match the - /// given regular expression to get updates from the server. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// </summary> - /// <exception cref="IllegalArgumentException"> - /// If the regular expression string is empty. - /// </exception> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// For pools configured with locators, if no locators are available, innerException - /// of NotConnectedException is set to NoAvailableLocatorsException. - /// </exception> - /// <exception cref="MessageException"> - /// If the message received from server could not be handled. This will - /// be the case when an unregistered typeId is received in the reply or - /// reply is not well formed. More information can be found in the log. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void RegisterRegex(String^ regex ); + /// <summary> + /// Register interest for the keys of the region that match the + /// given regular expression to get updates from the server. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// </summary> + /// <exception cref="IllegalArgumentException"> + /// If the regular expression string is empty. + /// </exception> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// For pools configured with locators, if no locators are available, innerException + /// of NotConnectedException is set to NoAvailableLocatorsException. + /// </exception> + /// <exception cref="MessageException"> + /// If the message received from server could not be handled. This will + /// be the case when an unregistered typeId is received in the reply or + /// reply is not well formed. More information can be found in the log. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void RegisterRegex(String^ regex); - /// <summary> - /// Register interest for the keys of the region that match the - /// given regular expression to get updates from the server. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// Should only be called for durable clients and with cache server version 5.5 onwards. - /// </summary> - /// <param name="regex">the regular expression to register</param> - /// <param name="isDurable">whether the registration should be durable</param> - /// <exception cref="IllegalArgumentException"> - /// If the regular expression string is empty. - /// </exception> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// For pools configured with locators, if no locators are available, innerException - /// of NotConnectedException is set to NoAvailableLocatorsException. - /// </exception> - /// <exception cref="MessageException"> - /// If the message received from server could not be handled. This will - /// be the case when an unregistered typeId is received in the reply or - /// reply is not well formed. More information can be found in the log. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void RegisterRegex( String^ regex, bool isDurable ); + /// <summary> + /// Register interest for the keys of the region that match the + /// given regular expression to get updates from the server. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// Should only be called for durable clients and with cache server version 5.5 onwards. + /// </summary> + /// <param name="regex">the regular expression to register</param> + /// <param name="isDurable">whether the registration should be durable</param> + /// <exception cref="IllegalArgumentException"> + /// If the regular expression string is empty. + /// </exception> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// For pools configured with locators, if no locators are available, innerException + /// of NotConnectedException is set to NoAvailableLocatorsException. + /// </exception> + /// <exception cref="MessageException"> + /// If the message received from server could not be handled. This will + /// be the case when an unregistered typeId is received in the reply or + /// reply is not well formed. More information can be found in the log. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void RegisterRegex(String^ regex, bool isDurable); - /// <summary> - /// Register interest for the keys of the region that match the - /// given regular expression to get updates from the server. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// Should only be called for durable clients and with cache server version 5.5 onwards. - /// </summary> - /// <param name="regex">the regular expression to register</param> - /// <param name="isDurable">whether the registration should be durable</param> - /// <param name="resultKeys"> - /// if non-null then the keys that match the regular expression - /// on the server are returned - ///</param> - /// <exception cref="IllegalArgumentException"> - /// If the regular expression string is empty. - /// </exception> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// For pools configured with locators, if no locators are available, innerException - /// of NotConnectedException is set to NoAvailableLocatorsException. - /// </exception> - /// <exception cref="MessageException"> - /// If the message received from server could not be handled. This will - /// be the case when an unregistered typeId is received in the reply or - /// reply is not well formed. More information can be found in the log. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void RegisterRegex(String^ regex, bool isDurable, - System::Collections::Generic::ICollection<TKey>^ resultKeys); + /// <summary> + /// Register interest for the keys of the region that match the + /// given regular expression to get updates from the server. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// Should only be called for durable clients and with cache server version 5.5 onwards. + /// </summary> + /// <param name="regex">the regular expression to register</param> + /// <param name="isDurable">whether the registration should be durable</param> + /// <param name="resultKeys"> + /// if non-null then the keys that match the regular expression + /// on the server are returned + ///</param> + /// <exception cref="IllegalArgumentException"> + /// If the regular expression string is empty. + /// </exception> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// For pools configured with locators, if no locators are available, innerException + /// of NotConnectedException is set to NoAvailableLocatorsException. + /// </exception> + /// <exception cref="MessageException"> + /// If the message received from server could not be handled. This will + /// be the case when an unregistered typeId is received in the reply or + /// reply is not well formed. More information can be found in the log. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void RegisterRegex(String^ regex, bool isDurable, + System::Collections::Generic::ICollection<TKey>^ resultKeys); - /// <summary> - /// Register interest for the keys of the region that match the - /// given regular expression to get updates from the server. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// Should only be called for durable clients and with cache server version 5.5 onwards. - /// </summary> - /// <param name="regex">the regular expression to register</param> - /// <param name="isDurable">whether the registration should be durable</param> - /// <param name="resultKeys"> - /// if non-null then the keys that match the regular expression - /// on the server are returned - ///</param> - /// <param name="getInitialValues"> - /// true to populate the cache with values of the keys - /// that were registered on the server - /// </param> - /// <exception cref="IllegalArgumentException"> - /// If the regular expression string is empty. - /// </exception> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// For pools configured with locators, if no locators are available, innerException - /// of NotConnectedException is set to NoAvailableLocatorsException. - /// </exception> - /// <exception cref="MessageException"> - /// If the message received from server could not be handled. This will - /// be the case when an unregistered typeId is received in the reply or - /// reply is not well formed. More information can be found in the log. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void RegisterRegex(String^ regex, bool isDurable, - System::Collections::Generic::ICollection<TKey>^ resultKeys, bool getInitialValues); + /// <summary> + /// Register interest for the keys of the region that match the + /// given regular expression to get updates from the server. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// Should only be called for durable clients and with cache server version 5.5 onwards. + /// </summary> + /// <param name="regex">the regular expression to register</param> + /// <param name="isDurable">whether the registration should be durable</param> + /// <param name="resultKeys"> + /// if non-null then the keys that match the regular expression + /// on the server are returned + ///</param> + /// <param name="getInitialValues"> + /// true to populate the cache with values of the keys + /// that were registered on the server + /// </param> + /// <exception cref="IllegalArgumentException"> + /// If the regular expression string is empty. + /// </exception> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// For pools configured with locators, if no locators are available, innerException + /// of NotConnectedException is set to NoAvailableLocatorsException. + /// </exception> + /// <exception cref="MessageException"> + /// If the message received from server could not be handled. This will + /// be the case when an unregistered typeId is received in the reply or + /// reply is not well formed. More information can be found in the log. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void RegisterRegex(String^ regex, bool isDurable, + System::Collections::Generic::ICollection<TKey>^ resultKeys, bool getInitialValues); - /// <summary> - /// Register interest for the keys of the region that match the - /// given regular expression to get updates from the server. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// Should only be called for durable clients and with cache server version 5.5 onwards. - /// </summary> - /// <param name="regex">the regular expression to register</param> - /// <param name="isDurable">whether the registration should be durable</param> - /// <param name="resultKeys"> - /// if non-null then the keys that match the regular expression - /// on the server are returned - ///</param> - /// <param name="getInitialValues"> - /// true to populate the cache with values of the keys - /// that were registered on the server - /// </param> - /// <param name="receiveValues"> - /// whether to act like notify-by-subscription is true - /// </param> - /// <exception cref="IllegalArgumentException"> - /// If the regular expression string is empty. - /// </exception> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// </exception> - /// <exception cref="MessageException"> - /// If the message received from server could not be handled. This will - /// be the case when an unregistered typeId is received in the reply or - /// reply is not well formed. More information can be found in the log. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void RegisterRegex(String^ regex, bool isDurable, - System::Collections::Generic::ICollection<TKey>^ resultKeys, bool getInitialValues, bool receiveValues); - - /// <summary> - /// Unregister interest for the keys of the region that match the - /// given regular expression to stop getting updates for them. - /// The regular expression must have been registered previously using - /// a <c>RegisterRegex</c> call. - /// Valid only for a Native Client region when client notification - /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. - /// </summary> - /// <exception cref="IllegalArgumentException"> - /// If the regular expression string is empty. - /// </exception> - /// <exception cref="IllegalStateException"> - /// If this regular expression has not been registered by a previous - /// call to <c>RegisterRegex</c>. - /// </exception> - /// <exception cref="CacheServerException"> - /// If an exception is received from the Java cache server. - /// </exception> - /// <exception cref="NotConnectedException"> - /// if not connected to the GemFire system because the client cannot - /// establish usable connections to any of the servers given to it. - /// For pools configured with locators, if no locators are available, innerException - /// of NotConnectedException is set to NoAvailableLocatorsException. - /// </exception> - /// <exception cref="RegionDestroyedException"> - /// If region destroy is pending. - /// </exception> - /// <exception cref="UnsupportedOperationException"> - /// If the region is not a Native Client region or - /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. - /// </exception> - /// <exception cref="TimeoutException"> - /// if the operation timed out - /// </exception> - /// <exception cref="UnknownException">For other exceptions.</exception> - void UnregisterRegex( String^ regex ); + /// <summary> + /// Register interest for the keys of the region that match the + /// given regular expression to get updates from the server. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// Should only be called for durable clients and with cache server version 5.5 onwards. + /// </summary> + /// <param name="regex">the regular expression to register</param> + /// <param name="isDurable">whether the registration should be durable</param> + /// <param name="resultKeys"> + /// if non-null then the keys that match the regular expression + /// on the server are returned + ///</param> + /// <param name="getInitialValues"> + /// true to populate the cache with values of the keys + /// that were registered on the server + /// </param> + /// <param name="receiveValues"> + /// whether to act like notify-by-subscription is true + /// </param> + /// <exception cref="IllegalArgumentException"> + /// If the regular expression string is empty. + /// </exception> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// </exception> + /// <exception cref="MessageException"> + /// If the message received from server could not be handled. This will + /// be the case when an unregistered typeId is received in the reply or + /// reply is not well formed. More information can be found in the log. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void RegisterRegex(String^ regex, bool isDurable, + System::Collections::Generic::ICollection<TKey>^ resultKeys, bool getInitialValues, bool receiveValues); + + /// <summary> + /// Unregister interest for the keys of the region that match the + /// given regular expression to stop getting updates for them. + /// The regular expression must have been registered previously using + /// a <c>RegisterRegex</c> call. + /// Valid only for a Native Client region when client notification + /// ( <see cref="AttributesFactory.SetClientNotificationEnabled" /> ) is true. + /// </summary> + /// <exception cref="IllegalArgumentException"> + /// If the regular expression string is empty. + /// </exception> + /// <exception cref="IllegalStateException"> + /// If this regular expression has not been registered by a previous + /// call to <c>RegisterRegex</c>. + /// </exception> + /// <exception cref="CacheServerException"> + /// If an exception is received from the Java cache server. + /// </exception> + /// <exception cref="NotConnectedException"> + /// if not connected to the Geode system because the client cannot + /// establish usable connections to any of the servers given to it. + /// For pools configured with locators, if no locators are available, innerException + /// of NotConnectedException is set to NoAvailableLocatorsException. + /// </exception> + /// <exception cref="RegionDestroyedException"> + /// If region destroy is pending. + /// </exception> + /// <exception cref="UnsupportedOperationException"> + /// If the region is not a Native Client region or + /// <see cref="AttributesFactory.SetClientNotificationEnabled" /> is false. + /// </exception> + /// <exception cref="TimeoutException"> + /// if the operation timed out + /// </exception> + /// <exception cref="UnknownException">For other exceptions.</exception> + void UnregisterRegex(String^ regex); }; } // namespace Client
http://git-wip-us.apache.org/repos/asf/geode/blob/fc9f1f6f/src/clicache/src/ITransactionWriter.hpp ---------------------------------------------------------------------- diff --git a/src/clicache/src/ITransactionWriter.hpp b/src/clicache/src/ITransactionWriter.hpp index bb41fff..e51d7ef 100644 --- a/src/clicache/src/ITransactionWriter.hpp +++ b/src/clicache/src/ITransactionWriter.hpp @@ -28,30 +28,30 @@ namespace Apache namespace Client { - /// <summary> - /// A callback that is allowed to veto a transaction. Only one TransactionWriter can exist - /// per cache, and only one TransactionWriter will be fired in the - /// entire distributed system for each transaction. - /// This writer can be used to update a backend data source before the GemFire - /// cache is updated during commit. If the backend update fails, the implementer - /// can throw a {<c>TransactionWriterException</c>} to veto the transaction. - /// </summary> - /// <seealso cref="CacheTransactionManager.SetWriter" /> - generic<class TKey, class TValue> - public interface class ITransactionWriter - { - public: - /// <summary> - /// Called before the transaction has finished committing, but after conflict checking. - /// Provides an opportunity for implementors to cause transaction abort by throwing a - /// TransactionWriterException - /// </summary> - /// <param name="te">the transaction event</param> - /// <exception cref="TransactionWriterException"> - /// in the event that the transaction should be rolled back - /// </exception> - /// <seealso cref="CacheTransactionManager.Commit" /> - void BeforeCommit(TransactionEvent<TKey, TValue>^ te); + /// <summary> + /// A callback that is allowed to veto a transaction. Only one TransactionWriter can exist + /// per cache, and only one TransactionWriter will be fired in the + /// entire distributed system for each transaction. + /// This writer can be used to update a backend data source before the Geode + /// cache is updated during commit. If the backend update fails, the implementer + /// can throw a {<c>TransactionWriterException</c>} to veto the transaction. + /// </summary> + /// <seealso cref="CacheTransactionManager.SetWriter" /> + generic<class TKey, class TValue> + public interface class ITransactionWriter + { + public: + /// <summary> + /// Called before the transaction has finished committing, but after conflict checking. + /// Provides an opportunity for implementors to cause transaction abort by throwing a + /// TransactionWriterException + /// </summary> + /// <param name="te">the transaction event</param> + /// <exception cref="TransactionWriterException"> + /// in the event that the transaction should be rolled back + /// </exception> + /// <seealso cref="CacheTransactionManager.Commit" /> + void BeforeCommit(TransactionEvent<TKey, TValue>^ te); }; } // namespace Client http://git-wip-us.apache.org/repos/asf/geode/blob/fc9f1f6f/src/clicache/src/Log.cpp ---------------------------------------------------------------------- diff --git a/src/clicache/src/Log.cpp b/src/clicache/src/Log.cpp index 08707f6..b3569ca 100644 --- a/src/clicache/src/Log.cpp +++ b/src/clicache/src/Log.cpp @@ -31,94 +31,94 @@ namespace Apache namespace Client { - void Log::Init( LogLevel level, String^ logFileName ) + void Log::Init(LogLevel level, String^ logFileName) { _GF_MG_EXCEPTION_TRY2 - ManagedString mg_lfname( logFileName ); - apache::geode::client::Log::init( static_cast<apache::geode::client::Log::LogLevel>( level ), - mg_lfname.CharPtr ); + ManagedString mg_lfname(logFileName); + apache::geode::client::Log::init(static_cast<apache::geode::client::Log::LogLevel>(level), + mg_lfname.CharPtr); _GF_MG_EXCEPTION_CATCH_ALL2 } - void Log::Init( LogLevel level, String^ logFileName, int32_t logFileLimit ) + void Log::Init(LogLevel level, String^ logFileName, int32_t logFileLimit) { _GF_MG_EXCEPTION_TRY2 - ManagedString mg_lfname( logFileName ); - apache::geode::client::Log::init( static_cast<apache::geode::client::Log::LogLevel>( level ), - mg_lfname.CharPtr, logFileLimit ); + ManagedString mg_lfname(logFileName); + apache::geode::client::Log::init(static_cast<apache::geode::client::Log::LogLevel>(level), + mg_lfname.CharPtr, logFileLimit); _GF_MG_EXCEPTION_CATCH_ALL2 } - void Log::Close( ) + void Log::Close() { - apache::geode::client::Log::close( ); + apache::geode::client::Log::close(); } - LogLevel Log::Level( ) + LogLevel Log::Level() { - return static_cast<LogLevel>( apache::geode::client::Log::logLevel( ) ); + return static_cast<LogLevel>(apache::geode::client::Log::logLevel()); } - void Log::SetLevel( LogLevel level ) + void Log::SetLevel(LogLevel level) { apache::geode::client::Log::setLogLevel( - static_cast<apache::geode::client::Log::LogLevel>( level ) ); + static_cast<apache::geode::client::Log::LogLevel>(level)); } - String^ Log::LogFileName( ) + String^ Log::LogFileName() { _GF_MG_EXCEPTION_TRY2 - return ManagedString::Get( apache::geode::client::Log::logFileName( ) ); + return ManagedString::Get(apache::geode::client::Log::logFileName()); _GF_MG_EXCEPTION_CATCH_ALL2 } - bool Log::Enabled( LogLevel level ) + bool Log::Enabled(LogLevel level) { return apache::geode::client::Log::enabled( - static_cast<apache::geode::client::Log::LogLevel>( level ) ); + static_cast<apache::geode::client::Log::LogLevel>(level)); } - void Log::Write( LogLevel level, String^ msg ) + void Log::Write(LogLevel level, String^ msg) { _GF_MG_EXCEPTION_TRY2 - ManagedString mg_msg( msg ); - apache::geode::client::Log::log( static_cast<apache::geode::client::Log::LogLevel>( level ), - mg_msg.CharPtr ); + ManagedString mg_msg(msg); + apache::geode::client::Log::log(static_cast<apache::geode::client::Log::LogLevel>(level), + mg_msg.CharPtr); _GF_MG_EXCEPTION_CATCH_ALL2 } - void Log::LogThrow( LogLevel level, String^ msg, System::Exception^ ex ) + void Log::LogThrow(LogLevel level, String^ msg, System::Exception^ ex) { - if ( ex != nullptr ) + if (ex != nullptr) { String^ logMsg = String::Format( System::Globalization::CultureInfo::CurrentCulture, - "GemFire exception {0} thrown: {1}{2}{3}", ex->GetType( ), - ex->Message, Environment::NewLine, msg ); - Log::Write( level, logMsg ); + "Geode exception {0} thrown: {1}{2}{3}", ex->GetType(), + ex->Message, Environment::NewLine, msg); + Log::Write(level, logMsg); } } - void Log::LogCatch( LogLevel level, String^ msg, System::Exception^ ex ) + void Log::LogCatch(LogLevel level, String^ msg, System::Exception^ ex) { - if ( ex != nullptr ) + if (ex != nullptr) { String^ logMsg = String::Format( System::Globalization::CultureInfo::CurrentCulture, - "GemFire exception {0} caught: {1}{2}{3}", ex->GetType( ), - ex->Message, Environment::NewLine, msg ); - Log::Write( level, logMsg ); - } // namespace Client - } // namespace Geode -} // namespace Apache + "Geode exception {0} caught: {1}{2}{3}", ex->GetType(), + ex->Message, Environment::NewLine, msg); + Log::Write(level, logMsg); + } // namespace Client + } // namespace Geode + } // namespace Apache } } http://git-wip-us.apache.org/repos/asf/geode/blob/fc9f1f6f/src/clicache/src/Log.hpp ---------------------------------------------------------------------- diff --git a/src/clicache/src/Log.hpp b/src/clicache/src/Log.hpp index 6744774..b1ab29c 100644 --- a/src/clicache/src/Log.hpp +++ b/src/clicache/src/Log.hpp @@ -90,7 +90,7 @@ namespace Apache /// <summary> /// Defines methods available to clients that want to write a log message - /// to their GemFire system's shared log file. + /// to their Geode system's shared log file. /// </summary> /// <remarks> /// Any attempt to use an instance after its connection is disconnected @@ -168,7 +168,7 @@ namespace Apache /// </summary> /// <param name="level">the logging level</param> /// <param name="logFileName">the log file name</param> - static void Init( LogLevel level, String^ logFileName ); + static void Init(LogLevel level, String^ logFileName); /// <summary> /// Initializes logging facility with given level, filename, and file size limit. @@ -177,49 +177,49 @@ namespace Apache /// <param name="logFileName">the log file name</param> /// <param name="logFileLimit">maximum allowable size of the log file, in bytes, /// or 0 for the default (1 Gbyte)</param> - static void Init( LogLevel level, String^ logFileName, int32_t logFileLimit ); + static void Init(LogLevel level, String^ logFileName, int32_t logFileLimit); /// <summary> /// Closes logging facility (until next init). /// </summary> - static void Close( ); + static void Close(); /// <summary> /// Returns the current log level. /// </summary> - static LogLevel Level( ); + static LogLevel Level(); /// <summary> /// Sets the current log level. /// </summary> - static void SetLevel( LogLevel level ); + static void SetLevel(LogLevel level); /// <summary> /// Returns the name of the current log file. /// NOTE: This function is for debugging only, as it is not completely /// thread-safe! /// </summary> - static String^ LogFileName( ); + static String^ LogFileName(); /// <summary> /// True if log messages at the given level are enabled. /// </summary> - static bool Enabled( LogLevel level ); + static bool Enabled(LogLevel level); /// <summary> /// Logs a message at the given level. /// </summary> - static void Write( LogLevel level, String^ msg ); + static void Write(LogLevel level, String^ msg); /// <summary> /// Logs both a message and a thrown exception. /// </summary> - static void LogThrow( LogLevel level, String^ msg, System::Exception^ ex ); + static void LogThrow(LogLevel level, String^ msg, System::Exception^ ex); /// <summary> /// Logs both a message and a caught exception. /// </summary> - static void LogCatch( LogLevel level, String^ msg, System::Exception^ ex ); + static void LogCatch(LogLevel level, String^ msg, System::Exception^ ex); // Convenience functions with variable number of arguments // as in String.Format @@ -228,98 +228,98 @@ namespace Apache /// Error level logging with variable number of arguments using /// format as in <c>System.String.Format</c>. /// </summary> - inline static void Error( String^ format, ... array<Object^>^ args ) + inline static void Error(String^ format, ... array<Object^>^ args) { - if(staticLogLevel >= LogLevel::Error) - Log::Write( LogLevel::Error, String::Format( - System::Globalization::CultureInfo::CurrentCulture, format, args ) ); + if (staticLogLevel >= LogLevel::Error) + Log::Write(LogLevel::Error, String::Format( + System::Globalization::CultureInfo::CurrentCulture, format, args)); } /// <summary> /// Warning level logging with variable number of arguments using /// format as in <c>System.String.Format</c>. /// </summary> - inline static void Warning( String^ format, ... array<Object^>^ args ) + inline static void Warning(String^ format, ... array<Object^>^ args) { - if(staticLogLevel >= LogLevel::Warning) - Log::Write( LogLevel::Warning, String::Format( - System::Globalization::CultureInfo::CurrentCulture, format, args ) ); + if (staticLogLevel >= LogLevel::Warning) + Log::Write(LogLevel::Warning, String::Format( + System::Globalization::CultureInfo::CurrentCulture, format, args)); } /// <summary> /// Info level logging with variable number of arguments using /// format as in <c>System.String.Format</c>. /// </summary> - inline static void Info( String^ format, ... array<Object^>^ args ) + inline static void Info(String^ format, ... array<Object^>^ args) { - if(staticLogLevel >= LogLevel::Info) - Log::Write( LogLevel::Info, String::Format( - System::Globalization::CultureInfo::CurrentCulture, format, args ) ); + if (staticLogLevel >= LogLevel::Info) + Log::Write(LogLevel::Info, String::Format( + System::Globalization::CultureInfo::CurrentCulture, format, args)); } /// <summary> /// Config level logging with variable number of arguments using /// format as in <c>System.String.Format</c>. /// </summary> - inline static void Config( String^ format, ... array<Object^>^ args ) + inline static void Config(String^ format, ... array<Object^>^ args) { - if(staticLogLevel >= LogLevel::Config) - Log::Write( LogLevel::Config, String::Format( - System::Globalization::CultureInfo::CurrentCulture, format, args ) ); + if (staticLogLevel >= LogLevel::Config) + Log::Write(LogLevel::Config, String::Format( + System::Globalization::CultureInfo::CurrentCulture, format, args)); } /// <summary> /// Fine level logging with variable number of arguments using /// format as in <c>System.String.Format</c>. /// </summary> - inline static void Fine( String^ format, ... array<Object^>^ args ) + inline static void Fine(String^ format, ... array<Object^>^ args) { - if(staticLogLevel >= LogLevel::Fine) - Log::Write( LogLevel::Fine, String::Format( - System::Globalization::CultureInfo::CurrentCulture, format, args ) ); + if (staticLogLevel >= LogLevel::Fine) + Log::Write(LogLevel::Fine, String::Format( + System::Globalization::CultureInfo::CurrentCulture, format, args)); } /// <summary> /// Finer level logging with variable number of arguments using /// format as in <c>System.String.Format</c>. /// </summary> - inline static void Finer( String^ format, ... array<Object^>^ args ) + inline static void Finer(String^ format, ... array<Object^>^ args) { - if(staticLogLevel >= LogLevel::Finer) - Log::Write( LogLevel::Finer, String::Format( - System::Globalization::CultureInfo::CurrentCulture, format, args ) ); + if (staticLogLevel >= LogLevel::Finer) + Log::Write(LogLevel::Finer, String::Format( + System::Globalization::CultureInfo::CurrentCulture, format, args)); } /// <summary> /// Finest level logging with variable number of arguments using /// format as in <c>System.String.Format</c>. /// </summary> - inline static void Finest( String^ format, ... array<Object^>^ args ) + inline static void Finest(String^ format, ... array<Object^>^ args) { - if(staticLogLevel >= LogLevel::Finest) - Log::Write( LogLevel::Finest, String::Format( - System::Globalization::CultureInfo::CurrentCulture, format, args ) ); + if (staticLogLevel >= LogLevel::Finest) + Log::Write(LogLevel::Finest, String::Format( + System::Globalization::CultureInfo::CurrentCulture, format, args)); } /// <summary> /// Debug level logging with variable number of arguments using /// format as in <c>System.String.Format</c>. /// </summary> - inline static void Debug( String^ format, ... array<Object^>^ args ) + inline static void Debug(String^ format, ... array<Object^>^ args) { - if(staticLogLevel >= LogLevel::Debug) - Log::Write( LogLevel::Debug, String::Format( - System::Globalization::CultureInfo::CurrentCulture, format, args ) ); + if (staticLogLevel >= LogLevel::Debug) + Log::Write(LogLevel::Debug, String::Format( + System::Globalization::CultureInfo::CurrentCulture, format, args)); } internal: - static void SetLogLevel( LogLevel level) + static void SetLogLevel(LogLevel level) { staticLogLevel = level; } - private: - static LogLevel staticLogLevel = LogLevel::Null; + private: + static LogLevel staticLogLevel = LogLevel::Null; }; } // namespace Client } // namespace Geode
