VMware GemFire Native C++ Reference  9.1
UserFunctionExecutionException.hpp
1 #pragma once
2 
3 #ifndef GEODE_USERFUNCTIONEXECUTIONEXCEPTION_H_
4 #define GEODE_USERFUNCTIONEXECUTIONEXCEPTION_H_
5 
6 /*
7  * Licensed to the Apache Software Foundation (ASF) under one or more
8  * contributor license agreements. See the NOTICE file distributed with
9  * this work for additional information regarding copyright ownership.
10  * The ASF licenses this file to You under the Apache License, Version 2.0
11  * (the "License"); you may not use this file except in compliance with
12  * the License. You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing, software
17  * distributed under the License is distributed on an "AS IS" BASIS,
18  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  * See the License for the specific language governing permissions and
20  * limitations under the License.
21  */
22 
23 #include "Serializable.hpp"
24 #include "CacheableString.hpp"
25 
26 namespace apache {
27 namespace geode {
28 namespace client {
29 class UserFunctionExecutionException;
30 typedef SharedPtr<UserFunctionExecutionException>
31  UserFunctionExecutionExceptionPtr;
32 
42  public:
47 
52 
57  virtual void toData(DataOutput& output) const;
58 
64  virtual Serializable* fromData(DataInput& input);
65 
75  virtual int32_t classId() const;
76 
86  virtual uint32_t objectSize() const;
87 
96  virtual int8_t typeId() const;
97 
102  CacheableStringPtr getMessage() { return m_message; }
103 
109  const char* msg = "UserFunctionExecutionException";
111  return str;
112  }
113 
114  private:
115  // never implemented.
117  void operator=(const UserFunctionExecutionException& other);
118 
119  CacheableStringPtr m_message; // error message
120 };
121 } // namespace client
122 } // namespace geode
123 } // namespace apache
124 
125 #endif // GEODE_USERFUNCTIONEXECUTIONEXCEPTION_H_
virtual ~UserFunctionExecutionException()
public methods
Definition: UserFunctionExecutionException.hpp:46
Each enum represents a predefined RegionAttributes in a Cache.
Definition: Assert.hpp:31
UserFunctionExecutionException(CacheableStringPtr msg)
constructors
static CacheableStringPtr create(const char *value, int32_t len=0)
Factory method for creating an instance of CacheableString from a null terminated C string optionally...
Definition: CacheableString.hpp:113
CacheableStringPtr getName()
return as CacheableStringPtr the Exception name returned from geode sendException api...
Definition: UserFunctionExecutionException.hpp:108
virtual void toData(DataOutput &output) const
serialize this object
virtual uint32_t objectSize() const
return the size in bytes of the instance being serialized.
Provide operations for writing primitive data values, byte arrays, strings, Serializable objects to a...
Definition: DataOutput.hpp:74
UserFunctionExecutionException class is used to encapsulate geode sendException in case of Function e...
Definition: UserFunctionExecutionException.hpp:37
virtual int8_t typeId() const
return the typeId byte of the instance being serialized.
virtual Serializable * fromData(DataInput &input)
deserialize this object, typical implementation should return the &#39;this&#39; pointer. ...
CacheableStringPtr getMessage()
return as CacheableStringPtr the Exception message returned from geode sendException api...
Definition: UserFunctionExecutionException.hpp:102
This abstract base class is the superclass of all user objects in the cache that can be serialized...
Definition: Serializable.hpp:53
virtual int32_t classId() const
Return the classId of the instance being serialized.
Provide operations for reading primitive data values, byte arrays, strings, Serializable objects from...
Definition: DataInput.hpp:56
This namespace contains all the Geode C++ API classes, enumerations and globals.

Pivotal GemFire C++ Cache API Documentation