Interface ISGISocketCastOption

Interface for socket cast options.

interface ISGISocketCastOption {
    DropGroup(ipAddress: any): boolean;
    GetBroadcast(): boolean;
    GetMulticastLoop(): boolean;
    GetMulticastTTL(): number;
    JoinGroup(ipAddress: any): boolean;
    SetBroadcast(enable: boolean): boolean;
    SetMulticastLoop(enable: boolean): boolean;
    SetMulticastTTL(ttl: number): boolean;
}

Hierarchy (View Summary)

ISGISocketCastOption
- ISGRODataGramSocket

Index

Methods

DropGroup GetBroadcast GetMulticastLoop GetMulticastTTL JoinGroup SetBroadcast SetMulticastLoop SetMulticastTTL

Methods

DropGroup

DropGroup(ipAddress: any): boolean
Drops multicast group
Parameters
- ipAddress: any
Returns boolean
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:2031

GetBroadcast

GetBroadcast(): boolean
Gets broadcast state

Returns boolean
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:2033

GetMulticastLoop

GetMulticastLoop(): boolean
Gets multicast loop state

Returns boolean
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:2035

GetMulticastTTL

GetMulticastTTL(): number
Gets multicast TTL

Returns number
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:2037

JoinGroup

JoinGroup(ipAddress: any): boolean
Joins multicast group
Parameters
- ipAddress: any
Returns boolean
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:2039

SetBroadcast

SetBroadcast(enable: boolean): boolean
Sets broadcast state
Parameters
- enable: boolean
Returns boolean
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:2041

SetMulticastLoop

SetMulticastLoop(enable: boolean): boolean
Sets multicast loop state
Parameters
- enable: boolean
Returns boolean
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:2043

SetMulticastTTL

SetMulticastTTL(ttl: number): boolean
Sets multicast TTL
Parameters
- ttl: number
Returns boolean
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:2045