PHOENIX-2715 Query Log (Ankit Singhal)
[phoenix.git] / phoenix-core / src / main / java / org / apache / phoenix / log / LogWriter.java
1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18 package org.apache.phoenix.log;
19
20 import java.io.IOException;
21 import java.sql.SQLException;
22
23 /**
24 * Used by the event handler to write RingBufferEvent, this is done in a seperate thread from the application configured
25 * during disruptor
26 */
27 public interface LogWriter {
28 /**
29 * Called by ring buffer event handler to write RingBufferEvent
30 *
31 * @param event
32 * @throws SQLException
33 * @throws IOException
34 */
35 void write(RingBufferEvent event) throws SQLException, IOException;
36
37 /**
38 * will be called when disruptor is getting shutdown
39 *
40 * @throws IOException
41 */
42
43 void close() throws IOException;
44
45 /**
46 * if writer is closed and cannot write further event
47 *
48 * @return
49 */
50 boolean isClosed();
51 }