client-server-anatomy in doc needs fixing/deleting + documentation concerns

[wickeduk]

Hi,

The code doesn't compile, build doesn't work (Java 11), it doesn't support the latest netty/finagle. At least the following problems will need correcting:

Pipeline:
object StringClientPipeline extends ChannelPipelineFactory {
def getPipeline = {
val pipeline = Channels.pipeline()
pipeline.addLast("stringEncode", new StringEncoder(CharsetUtil.UTF_8))
pipeline.addLast("stringDecode", new StringDecoder(CharsetUtil.UTF_8))
pipeline.addLast("line", new DelimEncoder('\n'))
pipeline
}

ChannelPipelineFactory doesn't exist any longer in netty4 (the package name).

newListener in Echo needs the transport parameter.

sbt:
-XX:+UseParNewGC
-XX:+UseConcMarkSweepGC \

These are gone by Java 11. It wasn't clear Java 14 is not being supported and what is/what it is tested on (found out by gitter channel).

If doc is still wanted and fixed up, it should be part of the build process to compile everything, or at least at release time so breakages are known.

If doc (part of) is deprecated it should be removed (wastes developer time trying to understand and gives a poor image), and users pointed to the tests for documentation (there is a near similar echo server in the tests).

I can't say the written finagle documentation is very good for someone trying to evaluate it as to what it can do and what it can't (non rpc servers for example that require the server to be able to push to connected clients which was my usecase), and how to get a simple socket server working. In tutorials / youtube presentations - too much is on the details and not enough on the basics. Why use/not use finagle vs other peer solutions, or pure netty (helps developers evaluate before diving in). Note that documentation concerns were highlighted in 2016 presentations.

Thanks,

David

NB. Not to sound ungrateful for the hard work put in and opening this to the community, it just needs a little polish.

[icoco]

same problem, confuse with the example .....