PLC/Methods/GetPeers.py

   1 #
   2 # Thierry Parmentelat - INRIA
   3 #
   4
   5 from PLC.Faults import *
   6 from PLC.Method import Method
   7 from PLC.Parameter import Parameter, Mixed
   8 from PLC.Filter import Filter
   9 from PLC.Auth import Auth
  10
  11 from PLC.Peers import Peer, Peers
  12
  13 class GetPeers (Method):
  14     """
  15     Returns an array of structs containing details about peers. If
  16     person_filter is specified and is an array of peer identifiers or
  17     peer names, or a struct of peer attributes, only peers matching
  18     the filter will be returned.
  19     """
  20
  21     roles = ['admin']
  22
  23     accepts = [
  24         Auth(),
  25         Mixed([Mixed(Peer.fields['peer_id'],
  26                      Peer.fields['peername'])],
  27               Filter(Peer.fields))
  28         ]
  29
  30     returns = [Peer.fields]
  31
  32     def call (self, auth, peer_filter = None):
  33         return Peers(self.api, peer_filter).values()