Top Methods
io.undertow.websockets.core.function

public Interface ChannelFunction

Known Direct Implementers
io.undertow.websockets.core.protocol.version07.Masker, io.undertow.websockets.core.protocol.version07.UTF8Checker
Imports
io.undertow.server.protocol.framed.FrameHeaderData, java.io.IOException, java.nio.ByteBuffer

Author
Norman Maurer

Method Summary

Modifier and TypeMethod and Description
public void
afterRead(ByteBuffer
the ByteBuffer to operate on
buf
,
int
the index in the ByteBuffer to start from
position
,
int
the number of bytes to operate on
length
)

Is called on the ByteBuffer after a read operation completes

public void
beforeWrite(ByteBuffer
the ByteBuffer to operate on
buf
,
int
the index in the ByteBuffer to start from
position
,
int
the number of bytes to operate on
length
)

Is called on the ByteBuffer before a write operation completes

public void
complete()

Is called to complete the ChannelFunction.

public void

Method Detail

afterReadback to summary
public void afterRead(ByteBuffer buf, int position, int length) throws IOException

Is called on the ByteBuffer after a read operation completes

Parameters
buf:ByteBuffer

the ByteBuffer to operate on

position:int

the index in the ByteBuffer to start from

length:int

the number of bytes to operate on

Exceptions
IOException:
thrown if an error occurs
beforeWriteback to summary
public void beforeWrite(ByteBuffer buf, int position, int length) throws IOException

Is called on the ByteBuffer before a write operation completes

Parameters
buf:ByteBuffer

the ByteBuffer to operate on

position:int

the index in the ByteBuffer to start from

length:int

the number of bytes to operate on

Exceptions
IOException:
thrown if an error occurs
completeback to summary
public void complete() throws IOException

Is called to complete the ChannelFunction. Access it after complete is called may result in unexpected behavior.

Exceptions
IOException:
thrown if an error occurs
newFrameback to summary
public void newFrame(FrameHeaderData headerData)