C++ Native Functions: com.teracloud.streams.network.location

This page documents native functions that can be invoked from SPL, including the SPL interfaces that can be used to invoke each of the native functions.

Functions

public rstring locationCityName(list<uint8>[16] ipv6Address): This result function returns the city name for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
public rstring locationCityName(uint32 ipv4Address): This result function returns the city name for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
public list<rstring> locationCityNames(list<uint32> ipv4Addresses): This result function returns a list of city names corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public rstring locationContinentCode(list<uint8>[16] ipv6Address): This result function returns the continent code for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
public rstring locationContinentCode(uint32 ipv4Address): This result function returns the continent code for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
public list<rstring> locationContinentCodes(list<uint32> ipv4Addresses): This result function returns a list of continent codes corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public rstring locationContinentName(list<uint8>[16] ipv6Address): This result function returns the continent name for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
public rstring locationContinentName(uint32 ipv4Address): This result function returns the continent name for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
public list<rstring> locationContinentNames(list<uint32> ipv4Addresses): This result function returns a list of continent names corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public rstring locationCountryCode(list<uint8>[16] ipv6Address): This result function returns the country code for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
public rstring locationCountryCode(uint32 ipv4Address): This result function returns the country code for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
public list<rstring> locationCountryCodes(list<uint32> ipv4Addresses): This result function returns a list of country codes corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public rstring locationCountryName(list<uint8>[16] ipv6Address): This result function returns the country name for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
public rstring locationCountryName(uint32 ipv4Address): This result function returns the country name for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
public list<rstring> locationCountryNames(list<uint32> ipv4Addresses): This result function returns a list of country names corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public boolean locationFound(list<uint8>[16] ipv6Address): This parser result function returns true if the location of the specified IP version 6 address was found, or false if not.
public boolean locationFound(uint32 ipv4Address): This parser result function returns true if the location of the specified IP version 4 address was found, or false if not.
public rstring locationGeohash(list<uint8>[16] ipv6Address, int32 precision): This result function returns the geohash of the specified precision for the specified IP version 6 address, if its location was found, or an empty string if not.
public rstring locationGeohash(uint32 ipv4Address, int32 precision): This result function returns the geohash of the specified precision for the specified IP version 4 address, if its location was found, or an empty string if not.
public rstring locationID(list<uint8>[16] ipv6Address): This result function returns the location identifier for the specified IP version 6 address, if one was found, or an empty string if not.
public rstring locationID(uint32 ipv4Address): This result function returns the location identifier for the specified IP version 4 address, if one was found, or an empty string if not.
public list<rstring> locationIDs(list<uint32> ipv4Addresses): This result function returns a list of IDs corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public rstring locationInEU(list<uint8>[16] ipv6Address): This result function returns an indication of whether or not the specified IP version 6 address is in the European Union, if its location was found and it has an indication, or an empty string if not.
public rstring locationInEU(uint32 ipv4Address): This result function returns an indication of whether or not the specified IP version 4 address is in the European Union, if its location was found and it has an indication, or an empty string if not.
public float64 locationLatitude(list<uint8>[16] ipv6Address): This result function returns the latitude for the specified IP version 6 address, if its location was found, or zero if not.
public float64 locationLatitude(uint32 ipv4Address): This result function returns the latitude for the specified IP version 4 address, if its location was found, or zero if not.
public list<float64> locationLatitudes(list<uint32> ipv4Addresses): This result function returns a list of latitudes corresponding to the specified list of IP version 4 addresses. Zeros are returned for IP addresses where no location is found.
public float64 locationLongitude(list<uint8>[16] ipv6Address): This result function returns the longitude for the specified IP version 6 address, if its location was found, or zero if not.
public float64 locationLongitude(uint32 ipv4Address): This result function returns the longitude for the specified IP version 4 address, if its location was found, or zero if not.
public list<float64> locationLongitudes(list<uint32> ipv4Addresses): This result function returns a list of longitudes corresponding to the specified list of IP version 4 addresses. Zeroes are returned for IP addresses where no location is found.
public rstring locationMetroCode(list<uint8>[16] ipv6Address): This result function returns the metro code for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
public rstring locationMetroCode(uint32 ipv4Address): This result function returns the metro code for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
public rstring locationPostalCode(list<uint8>[16] ipv6Address): This result function returns the postal code for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
public rstring locationPostalCode(uint32 ipv4Address): This result function returns the postal code for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
public list<rstring> locationPostalCodes(list<uint32> ipv4Addresses): This result function returns a list of postal codes corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public list<float64> locationRadii(list<uint32> ipv4Addresses): This result function returns a list of accuracy radii corresponding to the specified list of IP version 4 addresses. Zeros are returned for IP addresses where no location is found.
public float64 locationRadius(list<uint8>[16] ipv6Address): This result function returns the accuracy of the latitude and longitude, expressed as a radius, for the specified IP version 6 address, if its location was found, or zero if not.
public float64 locationRadius(uint32 ipv4Address): This result function returns the accuracy of the latitude and longitude for the specified IP version 4 address, expressed as a radius, if its location was found, or zero if not.
public rstring locationSubdivision1Code(list<uint8>[16] ipv6Address): This result function returns the first division code (typically a state or province) for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
public rstring locationSubdivision1Code(uint32 ipv4Address): This result function returns the first division code (typically a state or province) for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
public list<rstring> locationSubdivision1Codes(list<uint32> ipv4Addresses): This result function returns a list of first subdivision codes corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public rstring locationSubdivision1Name(list<uint8>[16] ipv6Address): This result function returns the first division name (typically a state or province) for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
public rstring locationSubdivision1Name(uint32 ipv4Address): This result function returns the first division name (typically a state or province) for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
public list<rstring> locationSubdivision1Names(list<uint32> ipv4Addresses): This result function returns a list of the first subdivision names corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public rstring locationSubdivision2Code(list<uint8>[16] ipv6Address): This result function returns the second division code for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
public rstring locationSubdivision2Code(uint32 ipv4Address): This result function returns the second division code for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
public list<rstring> locationSubdivision2Codes(list<uint32> ipv4Addresses): This result function returns a list of second subdivision codes corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public rstring locationSubdivision2Name(list<uint8>[16] ipv6Address): This result function returns the second division name for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
public rstring locationSubdivision2Name(uint32 ipv4Address): This result function returns the second division name for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
public list<rstring> locationSubdivision2Names(list<uint32> ipv4Addresses): This result function returns a list of the second subdivision names corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public rstring locationSubnet(list<uint8>[16] ipv6Address): This result function returns the IP subnet address and mask, in CIDR notation, for the specified IP version 6 address, if one was found, or an empty string if not.
public rstring locationSubnet(uint32 ipv4Address): This result function returns the IP subnet address and mask, in CIDR notation, for the specified IP version 4 address, if one was found, or an empty string if not.
public list<uint8>[16] locationSubnetAddress(list<uint8>[16] ipv6Address): This result function returns the IP version 6 subnet address for the specified IP version 6 address, if one was found, or zero if not.
public uint32 locationSubnetAddress(uint32 ipv4Address): This result function returns the IP version 4 subnet address for the specified IP version 4 address, if one was found, or zero if not.
public list<rstring> locationSubnetAddresses(list<uint32> ipv4Addresses): This result function returns a list of subnet addresses corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public list<uint8>[16] locationSubnetMask(list<uint8>[16] ipv6Address): This result function returns the IP version 6 subnet mask for the specified IP version 6 address, if one was found, or zero if not.
public uint32 locationSubnetMask(uint32 ipv4Address): This result function returns the IP version 4 subnet mask for the specified IP version 4 address, if one was found, or zero if not.
public list<rstring> locationSubnetMasks(list<uint32> ipv4Addresses): This result function returns a list of subnet masks corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public list<rstring> locationSubnets(list<uint32> ipv4Addresses): This result function returns a list of IP subnets and masks, in CIDR notation, corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public rstring locationTimezone(list<uint8>[16] ipv6Address): This result function returns the time zone for the specified IP version 6 address, if its location was found and it has one, or an empty string if not.
public rstring locationTimezone(uint32 ipv4Address): This result function returns the time zone for the specified IP version 4 address, if its location was found and it has one, or an empty string if not.
public list<rstring> locationTimezones(list<uint32> ipv4Addresses): This result function returns a list of time zones corresponding to the specified list of IP version 4 addresses. Empty strings are returned for IP addresses where no location is found.
public list<boolean> locationsFound(list<uint32> ipv4Addresses): This result function returns a list of booleans indicating whether or not the specified list of IP version 4 addresses were found. Empty strings are returned for IP addresses where no location is found.