|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.flume.channel.file.FileChannel
public class FileChannel
A durable Channel
implementation that uses the local file system for
its storage.
Nested Class Summary | |
---|---|
static class |
FileChannel.FileBackedTransaction
An implementation of Transaction for FileChannel s. |
Constructor Summary | |
---|---|
FileChannel()
|
Method Summary | |
---|---|
File |
getCompleteDirectory()
|
File |
getDirectory()
|
String |
getName()
|
File |
getOpenDirectory()
|
Transaction |
getTransaction()
|
boolean |
isInitialized()
|
void |
put(Event event)
Puts the given event in the channel. |
void |
setDirectory(File directory)
|
void |
shutdown()
Instructs the channel to release any resources held in preparation of shutting down. |
Event |
take()
Returns the next event from the channel if available. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FileChannel()
Method Detail |
---|
public void put(Event event) throws ChannelException
Channel
Puts the given event in the channel.
Note: This method must be invoked within an active Transaction boundary. Failure to do so can lead to unpredictable results.
put
in interface Channel
event
- the event to transport.
ChannelException
- in case this operation fails.Transaction.begin()
public Event take() throws ChannelException
Channel
Returns the next event from the channel if available. If the channel does not have any events available, this method would return null.
Note: This method must be invoked within an active Transaction boundary. Failure to do so can lead to unpredictable results.
take
in interface Channel
ChannelException
- in case this operation fails.Transaction.begin()
public Transaction getTransaction()
getTransaction
in interface Channel
public File getDirectory()
public void setDirectory(File directory)
public File getOpenDirectory()
public File getCompleteDirectory()
public boolean isInitialized()
public void shutdown()
Channel
shutdown
in interface Channel
public String getName()
getName
in interface Channel
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |