1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski #ifndef _STORE_STORLCKB_HXX_
25*b1cdbd2cSJim Jagielski #define _STORE_STORLCKB_HXX_ "$Revision: 1.6.8.1 $"
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski #include "sal/types.h"
28*b1cdbd2cSJim Jagielski
29*b1cdbd2cSJim Jagielski #include "rtl/ustring.h"
30*b1cdbd2cSJim Jagielski #include "rtl/ref.hxx"
31*b1cdbd2cSJim Jagielski
32*b1cdbd2cSJim Jagielski #include "object.hxx"
33*b1cdbd2cSJim Jagielski #include "storbase.hxx"
34*b1cdbd2cSJim Jagielski #include "storpage.hxx"
35*b1cdbd2cSJim Jagielski
36*b1cdbd2cSJim Jagielski namespace store
37*b1cdbd2cSJim Jagielski {
38*b1cdbd2cSJim Jagielski
39*b1cdbd2cSJim Jagielski struct OStoreDataPageData;
40*b1cdbd2cSJim Jagielski struct OStoreDirectoryPageData;
41*b1cdbd2cSJim Jagielski
42*b1cdbd2cSJim Jagielski /*========================================================================
43*b1cdbd2cSJim Jagielski *
44*b1cdbd2cSJim Jagielski * OStoreLockBytes interface.
45*b1cdbd2cSJim Jagielski *
46*b1cdbd2cSJim Jagielski *======================================================================*/
47*b1cdbd2cSJim Jagielski class OStoreLockBytes : public store::OStoreObject
48*b1cdbd2cSJim Jagielski {
49*b1cdbd2cSJim Jagielski public:
50*b1cdbd2cSJim Jagielski /** Construction.
51*b1cdbd2cSJim Jagielski */
52*b1cdbd2cSJim Jagielski OStoreLockBytes (void);
53*b1cdbd2cSJim Jagielski
54*b1cdbd2cSJim Jagielski /** create (two-phase construction).
55*b1cdbd2cSJim Jagielski * @param pManager [in]
56*b1cdbd2cSJim Jagielski * @param pPath [in]
57*b1cdbd2cSJim Jagielski * @param pName [in]
58*b1cdbd2cSJim Jagielski * @param eMode [in]
59*b1cdbd2cSJim Jagielski * @return store_E_None upon success
60*b1cdbd2cSJim Jagielski */
61*b1cdbd2cSJim Jagielski storeError create (
62*b1cdbd2cSJim Jagielski OStorePageManager *pManager,
63*b1cdbd2cSJim Jagielski rtl_String *pPath,
64*b1cdbd2cSJim Jagielski rtl_String *pName,
65*b1cdbd2cSJim Jagielski storeAccessMode eAccessMode);
66*b1cdbd2cSJim Jagielski
67*b1cdbd2cSJim Jagielski /** Read at Offset into Buffer.
68*b1cdbd2cSJim Jagielski * @param nOffset [in]
69*b1cdbd2cSJim Jagielski * @param pBuffer [out]
70*b1cdbd2cSJim Jagielski * @param nBytes [in]
71*b1cdbd2cSJim Jagielski * @param rnDone [out]
72*b1cdbd2cSJim Jagielski * @return store_E_None upon success
73*b1cdbd2cSJim Jagielski */
74*b1cdbd2cSJim Jagielski storeError readAt (
75*b1cdbd2cSJim Jagielski sal_uInt32 nOffset,
76*b1cdbd2cSJim Jagielski void *pBuffer,
77*b1cdbd2cSJim Jagielski sal_uInt32 nBytes,
78*b1cdbd2cSJim Jagielski sal_uInt32 &rnDone);
79*b1cdbd2cSJim Jagielski
80*b1cdbd2cSJim Jagielski /** Write at Offset from Buffer.
81*b1cdbd2cSJim Jagielski * @param nOffset [in]
82*b1cdbd2cSJim Jagielski * @param pBuffer [in]
83*b1cdbd2cSJim Jagielski * @param nBytes [in]
84*b1cdbd2cSJim Jagielski * @param rnDone [out]
85*b1cdbd2cSJim Jagielski * @return store_E_None upon success
86*b1cdbd2cSJim Jagielski */
87*b1cdbd2cSJim Jagielski storeError writeAt (
88*b1cdbd2cSJim Jagielski sal_uInt32 nOffset,
89*b1cdbd2cSJim Jagielski const void *pBuffer,
90*b1cdbd2cSJim Jagielski sal_uInt32 nBytes,
91*b1cdbd2cSJim Jagielski sal_uInt32 &rnDone);
92*b1cdbd2cSJim Jagielski
93*b1cdbd2cSJim Jagielski /** flush.
94*b1cdbd2cSJim Jagielski * @return store_E_None upon success
95*b1cdbd2cSJim Jagielski */
96*b1cdbd2cSJim Jagielski storeError flush (void);
97*b1cdbd2cSJim Jagielski
98*b1cdbd2cSJim Jagielski /** setSize.
99*b1cdbd2cSJim Jagielski * @param nSize [in]
100*b1cdbd2cSJim Jagielski * @return store_E_None upon success
101*b1cdbd2cSJim Jagielski */
102*b1cdbd2cSJim Jagielski storeError setSize (sal_uInt32 nSize);
103*b1cdbd2cSJim Jagielski
104*b1cdbd2cSJim Jagielski /** stat.
105*b1cdbd2cSJim Jagielski * @paran rnSize [out]
106*b1cdbd2cSJim Jagielski * @return store_E_None upon success
107*b1cdbd2cSJim Jagielski */
108*b1cdbd2cSJim Jagielski storeError stat (sal_uInt32 &rnSize);
109*b1cdbd2cSJim Jagielski
110*b1cdbd2cSJim Jagielski /** IStoreHandle.
111*b1cdbd2cSJim Jagielski */
112*b1cdbd2cSJim Jagielski virtual sal_Bool SAL_CALL isKindOf (sal_uInt32 nMagic);
113*b1cdbd2cSJim Jagielski
114*b1cdbd2cSJim Jagielski protected:
115*b1cdbd2cSJim Jagielski /** Destruction (OReference).
116*b1cdbd2cSJim Jagielski */
117*b1cdbd2cSJim Jagielski virtual ~OStoreLockBytes (void);
118*b1cdbd2cSJim Jagielski
119*b1cdbd2cSJim Jagielski private:
120*b1cdbd2cSJim Jagielski /** IStoreHandle TypeId.
121*b1cdbd2cSJim Jagielski */
122*b1cdbd2cSJim Jagielski static const sal_uInt32 m_nTypeId;
123*b1cdbd2cSJim Jagielski
124*b1cdbd2cSJim Jagielski /** IStoreHandle query() template specialization.
125*b1cdbd2cSJim Jagielski */
126*b1cdbd2cSJim Jagielski friend OStoreLockBytes*
127*b1cdbd2cSJim Jagielski SAL_CALL query<> (IStoreHandle *pHandle, OStoreLockBytes*);
128*b1cdbd2cSJim Jagielski
129*b1cdbd2cSJim Jagielski /** Representation.
130*b1cdbd2cSJim Jagielski */
131*b1cdbd2cSJim Jagielski rtl::Reference<OStorePageManager> m_xManager;
132*b1cdbd2cSJim Jagielski
133*b1cdbd2cSJim Jagielski typedef OStoreDataPageData data;
134*b1cdbd2cSJim Jagielski typedef OStoreDirectoryPageData inode;
135*b1cdbd2cSJim Jagielski
136*b1cdbd2cSJim Jagielski typedef PageHolderObject< inode > inode_holder_type;
137*b1cdbd2cSJim Jagielski inode_holder_type m_xNode;
138*b1cdbd2cSJim Jagielski
139*b1cdbd2cSJim Jagielski bool m_bWriteable;
140*b1cdbd2cSJim Jagielski
141*b1cdbd2cSJim Jagielski /** Not implemented.
142*b1cdbd2cSJim Jagielski */
143*b1cdbd2cSJim Jagielski OStoreLockBytes (const OStoreLockBytes&);
144*b1cdbd2cSJim Jagielski OStoreLockBytes& operator= (const OStoreLockBytes&);
145*b1cdbd2cSJim Jagielski };
146*b1cdbd2cSJim Jagielski
147*b1cdbd2cSJim Jagielski template<> inline OStoreLockBytes*
query(IStoreHandle * pHandle,OStoreLockBytes *)148*b1cdbd2cSJim Jagielski SAL_CALL query (IStoreHandle *pHandle, OStoreLockBytes*)
149*b1cdbd2cSJim Jagielski {
150*b1cdbd2cSJim Jagielski if (pHandle && pHandle->isKindOf (OStoreLockBytes::m_nTypeId))
151*b1cdbd2cSJim Jagielski {
152*b1cdbd2cSJim Jagielski // Handle is kind of OStoreLockBytes.
153*b1cdbd2cSJim Jagielski return static_cast<OStoreLockBytes*>(pHandle);
154*b1cdbd2cSJim Jagielski }
155*b1cdbd2cSJim Jagielski return 0;
156*b1cdbd2cSJim Jagielski }
157*b1cdbd2cSJim Jagielski
158*b1cdbd2cSJim Jagielski /*========================================================================
159*b1cdbd2cSJim Jagielski *
160*b1cdbd2cSJim Jagielski * The End.
161*b1cdbd2cSJim Jagielski *
162*b1cdbd2cSJim Jagielski *======================================================================*/
163*b1cdbd2cSJim Jagielski
164*b1cdbd2cSJim Jagielski } // namespace store
165*b1cdbd2cSJim Jagielski
166*b1cdbd2cSJim Jagielski #endif /* !_STORE_STORLCKB_HXX_ */
167*b1cdbd2cSJim Jagielski
168