Open Mash Cross Reference
mash/tcl/indiva/imgr/imgr-flow.tcl

   # imgr-flow.tcl --
   #
   #   This file implements the flow abstraction in an Indiva manager.
   #   A Flow is an abstraction that represents the sequence of cables 
   #   and network path a media stream/signal pass through.
   #
   # Copyright (c) 1996-2002 The Regents of the University of California.
   # All rights reserved.
   #
  # Redistribution and use in source and binary forms, with or without
  # modification, are permitted provided that the following conditions are met:
  #
  # A. Redistributions of source code must retain the above copyright notice,
  #    this list of conditions and the following disclaimer.
  # B. Redistributions in binary form must reproduce the above copyright notice,
  #    this list of conditions and the following disclaimer in the documentation
  #    and/or other materials provided with the distribution.
  # C. Neither the names of the copyright holders nor the names of its
  #    contributors may be used to endorse or promote products derived from this
  #    software without specific prior written permission.
  #
  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
  # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  # ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
  # ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  #
  # @(#) $Header: /usr/mash/src/repository/mash/mash-1/tcl/indiva/imgr/imgr-flow.tcl,v 1.5 2002/07/18 22:49:32 weitsang Exp $
  
  #------------------------------------------------------------------------
  # Class:
  #   ImgrFlow
  # Description:
  #   A signal/stream flow in a audio/video environment.  An object is 
  #   created by Indiva Manager whenever a request is received.
  # Members:
  #   src_, dest_ -- the origin and final destination of the flow.
  #   csock_ -- socket to the client.
  #   path_ -- a sequence of names of mob that the flows flow through.
  #   service_instance_ -- a tables of ASCP objects, indexed by two mobs.
  #     the ASCP object for a service that goes from $mob1 to $mob2 are
  #     stored as $service_instance_($mob1,$mob2)
  #   why_abort_ -- if defined, indicates that this flow has been aborted.
  #-----------------------------------------------------------------------
  Class IMgrFlow 
  
  IMgrFlow instproc init {src dest client} {
      $self instvar src_ dest_ csock_ path_ chost_ commit_ creation_time_
      set commit_ 0
      set src_ $src
      set dest_ $dest
      set csock_ $client
      if [catch {fconfigure $client -peername} chost_] {
          set chost_ ""
      }
      set creation_time_ ""
      set path_ ""
  }
  
  IMgrFlow instproc client {args} {
      $self instvar csock_
      if {$args == ""} {
          return $csock_
      } else {
          set csock_ $args
      }
  }
  
  IMgrFlow instproc host {} {
      $self instvar chost_
      return $chost_
  }
  
  IMgrFlow instproc src {args} {
      $self instvar src_
      if {$args == ""} {
          return $src_
      } else {
          set src_ $args
      }
  }
  
  IMgrFlow instproc dest {args} {
      $self instvar dest_
      if {$args == ""} {
          return $dest_
      } else {
          set dest_ $args
      }
  }
  
  IMgrFlow instproc service_instance {from to args} {
      $self instvar service_instance_
      if {$args == ""} {
         if [info exists service_instance_($from,$to)] {
             return $service_instance_($from,$to)
         } else {
             return ""
         }
     } else {
         set service_instance_($from,$to) $args
     }
 }
 
 
 IMgrFlow instproc service {from to args} {
     $self instvar service_
     if {$args == ""} {
         if [info exists service_($from,$to)] {
             return $service_($from,$to)
         } else {
             return ""
         }
     } else {
         set service_($from,$to) [join $args]
     }
 }
 
 
 IMgrFlow instproc path {args} {
     $self instvar path_
     if {$args == ""} {
         return $path_
     } else {
         eval set path_ $args
     }
 }
 
 
 IMgrFlow instproc abort {why} {
     $self instvar why_abort_
     set why_abort_ $why
 }
 
 
 IMgrFlow instproc why_abort? {} {
     $self set why_abort_
 }
 
 
 IMgrFlow instproc is_aborted {} {
     $self instvar why_abort_
     return [expr {[info exists why_abort_]} ? 1 : 0]
 }
 
 
 IMgrFlow instproc commit {} {
     $self set commit_ 1
     $self set creation_time_  [clock format [clock seconds] -format {%a, %d %b %Y %T %Z}]
 }
 
 IMgrFlow instproc is_committed {} {
     return [$self set commit_]
 }
 
 IMgrFlow instproc time {} {
     return [$self set creation_time_]
 }