GanAddress

GanAddress —

Synopsis




            GanAddress;
GanAddress* gan_address_dup                 (GanAddress *addr);
gboolean    gan_address_is_null             (GanAddress *addr);
gboolean    gan_address_equals              (GanAddress *this,
                                             GanAddress *that);
gchar*      gan_address_get_description     (GanAddress *addr);
GType       gan_address_get_transport_type  (GanAddress *addr);

Description

Details

GanAddress

typedef struct {
  GObject parent;
} GanAddress;

gan_address_dup ()

GanAddress* gan_address_dup                 (GanAddress *addr);

Duplicate an address.

addr : The address to duplicate.
Returns : A duplicate copy of addr.

gan_address_is_null ()

gboolean    gan_address_is_null             (GanAddress *addr);

Check whether an address is "null." The null status of an address is specific to its subtype; it is determined by calling an overridden method.

addr : The address to check.
Returns : TRUE if the address is null, or FALSE if it isn't.

gan_address_equals ()

gboolean    gan_address_equals              (GanAddress *this,
                                             GanAddress *that);

Check two address for equality.

Equality is determined first by checking the two address' types. If they differ, they are not counted as being equal. If they are the same, a subtype-specific function is used to determine equality.

this : The address whose equality is to be checked.
that : The address to check equality against.
Returns : True if the addresses are equal, or FALSE if they are not.

gan_address_get_description ()

gchar*      gan_address_get_description     (GanAddress *addr);

Get a human-readable description of the address.

The returned string must be freed by the caller.

addr : The address to describe.
Returns : A description of the address.

gan_address_get_transport_type ()

GType       gan_address_get_transport_type  (GanAddress *addr);

Get the GType of the GanTransport for which an address is used.

addr : The address whose transport type should be returned.
Returns : The type of the transport for which the address is used.