TCP keepalive on server side

[Judochopalots]

This is more of a question than an issue.

Is there currently a way to set TCP keepalive on the server socket?

I haven't tried it yet, but it looks to be possible to do this after the socket is opened. But I think it would be nicer if it was integrated into the server config

Best regards,
Nick

edit 1:

So I've found the point where the server is being created.

opcua-asyncio/asyncua/server/binary_server_asyncio.py

Line 129 in cf278b5

self._server = await self.iserver.loop.create_server(self._make_protocol, self.hostname, self.port)

I'm not sure how I can expose the socket (or if it's even possible). And if it is possible, is there a way to enable it like written here. It's straight forward when using the built in socket library.

edit 2:
Since the socket objects are available through the returned Server object, is it as simple as adding something like this just after the server is created?

self._server.sockets[0].setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)

[oroulet]

how do you use that feature? What is your goal?

[Judochopalots]

End goal is just to enable the tcp-keepalive on the server socket. I've been told this is a generally recommended thing for some servers, as it can help prevent denial of service events.

[AndreasHeine]

https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_server
coroutine loop.create_server(protocol_factory, host=None, port=None, *, family=socket.AF_UNSPEC, flags=socket.AI_PASSIVE, sock=None, backlog=100, ssl=None, reuse_address=None, reuse_port=None, ssl_handshake_timeout=None, start_serving=True)

backlog is the maximum number of queued connections passed to listen() (defaults to 100).

opcua-asyncio/asyncua/server/binary_server_asyncio.py

Line 129 in cf278b5

self._server = await self.iserver.loop.create_server(self._make_protocol, self.hostname, self.port)

so i would assume after 100 connections you have your "DoS"

would be neat feature do sort those inactive clients out aswell es a possible auto reconnect behaivior!?

[Judochopalots]

Correct. This is what the tcp-keepalive will prevent, after a certain time it will check that the client is still connected and kick it off if there's no response.

[AndreasHeine]

unfortunatly i cant find that socket type socket.SO_KEEPALIVE looks like they renamed it socket.SIO_KEEPALIVE_VALS
https://docs.python.org/3/library/socket.html

i would assume that you can predifine the sock argument in create_server like:

define socket with self.hostname, self.port
self._server = await self.iserver.loop.create_server(self._make_protocol, sock=_your predifined socket_)

https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_server
coroutine loop.create_server(protocol_factory, host=None, port=None, *, family=socket.AF_UNSPEC, flags=socket.AI_PASSIVE, sock=None, backlog=100, ssl=None, reuse_address=None, reuse_port=None, ssl_handshake_timeout=None, start_serving=True)

sock can optionally be specified in order to use a preexisting socket object. If specified, host and port must not be specified.

[Judochopalots]

Sorry for the late reply, I had some other issues I had to solve first.

I think you're right, that's one way to do it. I done it slightly differently, the socket object is exposed through self._server.sockets[0] and you can enable the tcp-keepalive directly there.

I'll tidy it up a bit and make a PR, but just for reference here's the quick change I made and tested that it works.

https://github.com/nickjhall/opcua-asyncio/blob/caeb2579e22518e4ff4bd761e872401328e0b301/asyncua/server/binary_server_asyncio.py#L139