Unix & Linux
shell networking process open-files
Updated Tue, 26 Jul 2022 06:17:16 GMT

How do I tell a script to wait for a process to start accepting requests on a port?


I need a command that will wait for a process to start accepting requests on a specific port.

Is there something in linux that does that?

while (checkAlive -host localhost -port 13000 == false)
  do some waiting
...



Solution

The best test to see if a server is accepting connections is to actually try connecting. Use a regular client for whatever protocol your server speaks and try a no-op command.

If you want a lightweight TCP or UDP client you can drive simply from the shell, use netcat. How to program a conversation depends on the protocol; many protocols have the server close the connection on a certain input, and netcat will then exit.

while ! echo exit | nc localhost 13000; do sleep 10; done

You can also tell netcat to exit after establishing the connection. It returns 1 if there's no connection and 0 if there is so we negate its output. Depending on your version of netcat, it may support one or both of the following commands:

while ! nc -z localhost 13000 </dev/null; do sleep 10; done
while ! nc -q 1 localhost 13000 </dev/null; do sleep 10; done

An alternative approach is to wait for the server process to open a listening socket.

while netstat -lnt | awk '$4 ~ /:13000$/ {exit 1}'; do sleep 10; done

If you are on Mac OS, netstat uses a slightly different output format, so you would want the following intead:

while netstat -lnt | awk '$4 ~ /\.13000$/ {exit 1}'; do sleep 10; done

Or you might want to target a specific process ID:

while ! lsof -n -Fn -p $pid | grep -q '^n.*:13000$'; do sleep 10; done

I can't think of any way to react to the process starting to listen to the socket (which would avoid a polling approach) short of using ptrace.





Comments (5)

  • +0 – I think netcat is the answer, so thank you. To clarify, what I'm trying to do is write a script as part of a load balancing procedure. I need to start a process, wait for it to accept requests on the port and then shutdown the original. If there are better ways of doing this, rather than writing my own script, I'm all ears. — Dec 31, 2010 at 16:36  
  • +0 – @Will: That's a very different question! I've written a different answer. — Dec 31, 2010 at 17:37  
  • +1 – I like netcat solution too. I have a script using nc -w 2 </dev/null >/dev/null if the connection takes more than 2 seconds, it times out and fails which is handy for my usage. — Jan 09, 2011 at 23:10  
  • +0 – FYI, I can't get the 'while nc -q 1 localhost 13000 </dev/null; do sleep 10; done' one to work. It just returns immediately. The first one works fine though. Thanks! — Mar 19, 2015 at 16:04  
  • +0 – @Flyte nc -q 1 localhost 13000 </dev/null returns immediately if no server is listening, but it returns with an error code, so the loop makes it sleep and try again a few seconds later. — Mar 19, 2015 at 17:16  


External Links

External links referenced by this document: