Skip to content

Use separate bind and listen primitives instead of combined listenOn:… family #14593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 6, 2023
Merged

Use separate bind and listen primitives instead of combined listenOn:… family #14593

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 46 additions & 44 deletions src/Network-Kernel/Socket.class.st
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,18 @@ Socket >> address [

{ #category : #'initialize - destroy' }
Socket >> bindTo: anAddress port: aPort [
^self primSocket: socketHandle bindTo: anAddress port: aPort
"Bind to the local port <aPort>, on the interface specified by <anAddress>
(`SocketAddress zero` specifies all interfaces).
Primarily used to prepare to listen for incoming connections with #listen[WithBacklog:]."

self primSocket: socketHandle bindTo: anAddress port: aPort
]

{ #category : #'initialize - destroy' }
Socket >> bindToPort: aPort [
"Bind to the local port <aPort>, often in order to listen for incoming connections."

self bindTo: SocketAddress zero port: aPort
]

{ #category : #'private - errors' }
Expand Down Expand Up @@ -738,37 +749,52 @@ Socket >> isWaitingForConnection [
]

{ #category : #'connection open/close' }
Socket >> listenOn: port [
"Listen for a connection on the given port. This operation will return immediately; follow it with waitForConnectionUntil: to wait until a connection is established."
Socket >> listen [
"Listen for a connection (after binding to a port using #bindTo:port:).
If this method succeeds, you must wait for a connection attempt with #waitForConnectionFor:,
then #accept may be used to establish a new connection"

| status |
status := self primSocketConnectionStatus: socketHandle.
(status == Unconnected)
ifFalse: [InvalidSocketStatusException signal: 'Socket status must Unconnected before listening for a new connection'].
self listenWithBacklog: 1
]

self primSocket: socketHandle listenOn: port
{ #category : #'connection open/close' }
Socket >> listenOn: port [

self
bindToPort: port;
listen
]

{ #category : #'connection open/close' }
Socket >> listenOn: portNumber backlogSize: backlog [
"Listen for a connection on the given port.
If this method succeeds, #accept may be used to establish a new connection"
| status |
status := self primSocketConnectionStatus: socketHandle.
(status == Unconnected)
ifFalse: [InvalidSocketStatusException signal: 'Socket status must Unconnected before listening for a new connection'].
self primSocket: socketHandle listenOn: portNumber backlogSize: backlog

self
bindToPort: portNumber;
listenWithBacklog: backlog
]

{ #category : #'connection open/close' }
Socket >> listenOn: portNumber backlogSize: backlog interface: ifAddr [
"Listen for a connection on the given port.
If this method succeeds, #accept may be used to establish a new connection"

self
bindTo: ifAddr port: portNumber;
listenWithBacklog: backlog
]

{ #category : #'connection open/close' }
Socket >> listenWithBacklog: anIntegerBacklog [
"Listen for a connection, allowing <anIntegerBacklog> connections to be queued by the OS.
Must already be bound to a port using #bindTo:port:.
If this method succeeds, you must wait for a connection attempt with #waitForConnectionFor:,
then #accept may be used to establish a new connection"

| status |
status := self primSocketConnectionStatus: socketHandle.
(status == Unconnected)
ifFalse: [InvalidSocketStatusException signal: 'Socket status must Unconnected before listening for a new connection'].
self primSocket: socketHandle listenOn: portNumber backlogSize: backlog interface: ifAddr
status == Unconnected ifFalse: [
InvalidSocketStatusException signal:
'Socket status must Unconnected before listening for a new connection' ].

self primSocket: socketHandle listenWithBacklog: anIntegerBacklog
]

{ #category : #accessing }
Expand Down Expand Up @@ -873,30 +899,6 @@ Socket >> primSocket: socketID getOption: aString [
^ SocketError signal: self socketErrorMessage
]

{ #category : #primitives }
Socket >> primSocket: socketID listenOn: port [
"Listen for a connection on the given port. This is an asynchronous call; query the socket status to discover if and when the connection is actually completed."

<primitive: 'primitiveSocketListenWithOrWithoutBacklog' module: 'SocketPlugin'>
^ SocketError signal: self socketErrorMessage
]

{ #category : #primitives }
Socket >> primSocket: aHandle listenOn: portNumber backlogSize: backlog [
"Primitive. Set up the socket to listen on the given port.
Will be used in conjunction with #accept only."
<primitive: 'primitiveSocketListenWithOrWithoutBacklog' module: 'SocketPlugin'>
self destroy. "Accept not supported so clean up"
]

{ #category : #primitives }
Socket >> primSocket: aHandle listenOn: portNumber backlogSize: backlog interface: ifAddr [
"Primitive. Set up the socket to listen on the given port.
Will be used in conjunction with #accept only."
<primitive: 'primitiveSocketListenOnPortBacklogInterface' module: 'SocketPlugin'>
self destroy. "Accept not supported so clean up"
]

{ #category : #'primitives - ipv6' }
Socket >> primSocket: socketID listenWithBacklog: backlogSize [

Expand Down