Class: Fam::Event

# Fam::Event (Class)

In: | fam.c
Parent: | Data

## Methods

code filename hostname reqnum to_s

## Public Instance methods

code()

Return the code (type) of a Fam::Event object.

Note: see the file doc/event_codes.txt for a brief description of each event code.

Examples:

      code = ev.code

filename()

Return the filename of a Fam::Event object.

Note: for directory monitors, this method returns the path of the file relative to the monitor directory, not the full path.

Aliases:

      Fam::Event#file

Examples:

      path = ev.filename
      path = ev.file

hostname()

Return the hostname of a Fam::Event object.

Note: some versions of FAM (ex. the Debian package) ship without remote support. In those instances, this method will always return "localhost".

Aliases:

      Fam::Event#host

Examples:

      host = ev.hostname
      host = ev.host

reqnum()

Return the request number of a Fam::Event object.

Aliases:

      Fam::Event#request_number
      Fam::Event#request_num
      Fam::Event#request
      Fam::Event#req_num
      Fam::Event#req
      Fam::Event#num

Examples:

      req = ev.request_number

to_s()

Return a human-readable string-representation of a Fam::Event object.

Examples:

      puts 'event: ' << ev.to_s

[Validate]