ServiceProtocol Property

The protocol of the service specified by ServiceName / ServicePort .

Syntax

 ipinfo.getServiceProtocol([callback])
 ipinfo.setServiceProtocol( serviceProtocol, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getServiceProtocol([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setServiceProtocol([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property contains the protocol for the service specified by ServiceName.

Setting this property to a particular protocol name (for example 'udp' or 'tcp') will force a search for a service for that protocol only. If this property is set to "" (empty string) then the first entry for the service will be returned and this property will be set to the corresponding protocol.

NOTE: This functionality is only available in Windows.

Data Type

String