Package org.simpleframework.http.core
Class FixedLengthEncoder
java.lang.Object
org.simpleframework.http.core.FixedLengthEncoder
- All Implemented Interfaces:
BodyEncoder
The
FixedLengthEncoder
object produces content without
any encoding, but limited to a fixed number of bytes. This is used if
the length of the content being delivered is know beforehand. It
will simply count the number of bytes being send and signal the
server kernel that the next request is ready to read once all of
the bytes have been sent to the client.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate long
This is the number of bytes that have been sent so far.private long
This is the number of bytes this producer is limited to.private BodyObserver
This is the observer used to notify the initiator of events.private ByteWriter
This is the underlying writer used to deliver the raw data. -
Constructor Summary
ConstructorsConstructorDescriptionFixedLengthEncoder
(BodyObserver observer, ByteWriter writer, long limit) Constructor for theFixedLengthEncoder
object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
This is used to signal to the producer that all content has been written and the user no longer needs to write.void
encode
(byte[] array) This method is used to encode the provided array of bytes in a HTTP/1.1 complaint format and sent it to the client.void
encode
(byte[] array, int off, int len) This method is used to encode the provided array of bytes in a HTTP/1.1 complaint format and sent it to the client.void
encode
(ByteBuffer buffer) This method is used to encode the provided buffer of bytes in a HTTP/1.1 compliant format and sent it to the client.void
encode
(ByteBuffer buffer, int off, int len) This method is used to encode the provided buffer of bytes in a HTTP/1.1 compliant format and sent it to the client.void
flush()
This method is used to flush the contents of the buffer to the client.
-
Field Details
-
observer
This is the observer used to notify the initiator of events. -
writer
This is the underlying writer used to deliver the raw data. -
count
private long countThis is the number of bytes that have been sent so far. -
limit
private long limitThis is the number of bytes this producer is limited to.
-
-
Constructor Details
-
FixedLengthEncoder
Constructor for theFixedLengthEncoder
object. This is used to create an encoder that will count the number of bytes that are sent over the pipeline, once all bytes have been sent this will signal that the next request is ready to read.- Parameters:
observer
- this is used to deliver signals to the kernelwriter
- this is used to send to the underlying transportlimit
- this is used to limit the number of bytes sent
-
-
Method Details
-
encode
This method is used to encode the provided array of bytes in a HTTP/1.1 complaint format and sent it to the client. Once the data has been encoded it is handed to the transport layer within the server, which may choose to buffer the data if the content is too small to send efficiently or if the socket is not write ready.- Specified by:
encode
in interfaceBodyEncoder
- Parameters:
array
- this is the array of bytes to send to the client- Throws:
IOException
-
encode
This method is used to encode the provided array of bytes in a HTTP/1.1 complaint format and sent it to the client. Once the data has been encoded it is handed to the transport layer within the server, which may choose to buffer the data if the content is too small to send efficiently or if the socket is not write ready.- Specified by:
encode
in interfaceBodyEncoder
- Parameters:
array
- this is the array of bytes to send to the clientoff
- this is the offset within the array to send fromlen
- this is the number of bytes that are to be sent- Throws:
IOException
-
encode
This method is used to encode the provided buffer of bytes in a HTTP/1.1 compliant format and sent it to the client. Once the data has been encoded it is handed to the transport layer within the server, which may choose to buffer the data if the content is too small to send efficiently or if the socket is not write ready.- Specified by:
encode
in interfaceBodyEncoder
- Parameters:
buffer
- this is the buffer of bytes to send to the client- Throws:
IOException
-
encode
This method is used to encode the provided buffer of bytes in a HTTP/1.1 compliant format and sent it to the client. Once the data has been encoded it is handed to the transport layer within the server, which may choose to buffer the data if the content is too small to send efficiently or if the socket is not write ready.- Specified by:
encode
in interfaceBodyEncoder
- Parameters:
buffer
- this is the buffer of bytes to send to the clientoff
- this is the offset within the buffer to send fromlen
- this is the number of bytes that are to be sent- Throws:
IOException
-
flush
This method is used to flush the contents of the buffer to the client. This method will block until such time as all of the data has been sent to the client. If at any point there is an error sending the content an exception is thrown.- Specified by:
flush
in interfaceBodyEncoder
- Throws:
IOException
-
close
This is used to signal to the producer that all content has been written and the user no longer needs to write. This will either close the underlying transport or it will notify the monitor that the response has completed and the next request can begin. This ensures the content is flushed to the client.- Specified by:
close
in interfaceBodyEncoder
- Throws:
IOException
-