YLTCPBroadcaster Class Reference
| Inherits from | NSObject |
| Declared in | YLTCPBroadcaster.h |
Overview
An YLTCPBroadcaster object allows you to find every host on the specified
network with a given TCP port open. E.g. find on your local network every
hosts with the port 8080 open.
YLTCPBroadcaster is fully GCD (Grand Central Dispatch) based and
Thread-Safe.
It works by broadcasting a TCP connection to every host on the network (using the subnet mask) and by waiting the response for each one. In this manner it can determine whether the host is open on the given port.
Tasks
Creating and Initializing TCP Broadcasters
Getting Broadcaster Properties
-
ipproperty -
subnetMaskproperty -
networkPrefixproperty -
broadcastAddressproperty
Scanning the Network
Properties
broadcastAddress
The receiver’s broadcast address.
@property (nonatomic, strong, readonly) NSString *broadcastAddressAvailability
1.0.0
Declared In
YLTCPBroadcaster.hip
The receiver’s ip address.
@property (nonatomic, strong, readonly) NSString *ipAvailability
1.0.0
Declared In
YLTCPBroadcaster.hClass Methods
broadcasterWithIp:subnetMask:
Creates a broadcaster with an ip and its subnet mask.
+ (instancetype)broadcasterWithIp:(NSString *)ip subnetMask:(NSString *)subnetMaskAvailability
1.0.0
See Also
Declared In
YLTCPBroadcaster.hdefaultBroadcaster
Creates and returns the default broadcaster.
+ (instancetype)defaultBroadcasterAvailability
1.0.0
Discussion
The default broadcaster corresponding to the default device
network. It means the broadcaster’s ip, subnetMask, networkPrefix
and broadcastAddress are the same of the current device.
Declared In
YLTCPBroadcaster.hInstance Methods
initWithIp:subnetMask:
Initializes a broadcaster with an ip and its subnet mask.
- (id)initWithIp:(NSString *)ip subnetMask:(NSString *)subnetMaskAvailability
1.0.0
Discussion
In order to perform the request the ip and the subnet mask should be the same of the current device.
Declared In
YLTCPBroadcaster.hscanWithPort:completionHandler:
Performs an asynchronous scan of the current network to find every host which are listening on a given TCP port number.
- (void)scanWithPort:(SInt32)port completionHandler:(YLTCPBroadcasterCompletionBlock)completionBlockParameters
- port
The TCP port number to which the socket should connect.
- completionBlock
A broadcaster completion block.
Availability
1.0.0
Discussion
The operation is performed with the
kYLTCPSocketDefaultTimeoutInSeconds timeout value.
Declared In
YLTCPBroadcaster.hscanWithPort:timeoutInterval:completionHandler:
Performs an asynchronous scan of the current network to find every host which are listening on a given TCP port number. The operation is stopped if the time exceeded the timeout.
- (void)scanWithPort:(SInt32)port timeoutInterval:(NSTimeInterval)timeout completionHandler:(YLTCPBroadcasterCompletionBlock)completionBlockParameters
- port
The TCP port number to which the socket should connect.
- timeout
The timeout interval for the operation, in seconds.
- completionBlock
A broadcaster completion block.
Availability
1.0.0
Discussion
The operation runs entirely within its own GCD dispatch_queue and it calls the completion handler on the main queue when it finishes. If no host is found and/or if an error occured the returned list is empty.
Declared In
YLTCPBroadcaster.h