C++ Client API Reference for Oracle Coherence: coherence/io/pof/PortableObjectSerializer.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_PORTABLE_OBJECT_SERIALIZER_HPP
00008 #define COH_PORTABLE_OBJECT_SERIALIZER_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/io/pof/PofReader.hpp"
00013 #include "coherence/io/pof/PofSerializer.hpp"
00014 #include "coherence/io/pof/PofWriter.hpp"
00015 
00016 COH_OPEN_NAMESPACE3(coherence,io,pof)
00017 
00018 
00019 /**
00020 * A PofSerializer implementation that supports the serialization and
00021 * deserialization of any class that implements PortableObject to and
00022 * from a POF stream.
00023 *
00024 * @author jh  2008.01.18
00025 */
00026 class COH_EXPORT PortableObjectSerializer
00027     : public class_spec<PortableObjectSerializer,
00028         extends<Object>,
00029         implements<PofSerializer> >
00030     {
00031     friend class factory<PortableObjectSerializer>;
00032 
00033     // ----- constructors ---------------------------------------------------
00034 
00035     protected:
00036         /**
00037         * Create a new PortableObjectSerializer for the user type with the
00038         * given type identifier.
00039         *
00040         * @param nTypeId  the type identifier of a class that needs to be
00041         *                 serialized or deserialized
00042         */
00043         PortableObjectSerializer(int32_t nTypeId);
00044 
00045 
00046     // ----- PofSerializer interface ----------------------------------------
00047 
00048     public:
00049         /**
00050         * {@inheritDoc}
00051         */
00052         virtual void serialize(PofWriter::Handle hOut, Object::View v) const;
00053 
00054         /**
00055         * {@inheritDoc}
00056         */
00057         virtual Object::Holder deserialize(PofReader::Handle hIn) const;
00058 
00059 
00060     // ---- data members ----------------------------------------------------
00061 
00062     protected:
00063         /**
00064         * POF user type supported by this PortableObjectSerializer.
00065         */
00066         int32_t m_nTypeId;
00067     };
00068 
00069 COH_CLOSE_NAMESPACE3
00070 
00071 #endif // COH_PORTABLE_OBJECT_SERIALIZER_HPP